Shareware Super Platinum 8

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / ARCHIVE / JAM110SW.ZIP;1 / JAM.DOC < prev next >

Wrap

Text File | 1994-06-12 | 180.8 KB | 4,485 lines

mm mmmmmmmmmmmmm mmmmmmmmm (tm) mm mm mm mm mm The mm mmmmmm mm mm mm mm mm mm mm mm mm mm mm mmmmm mmmm mm mmm mmm Real-Time Data Compression Utilities Version 1.10 for IBM/PC/XT/AT, PS/1, PS/2 and compatibles ================================================ Copyright (c) JAM Software, 1992-1994. All Rights Reserved. JAM 1.10 User's Guide Page 1 ------------------------------------------------------------------------ Copyright (c) JAM Software, 1992-1994. All rights reserved. Disclaimer JAM Software disclaims all warranties as to this software or documentation, whether express or implied, including without limitation any implied warranties of merchantability, fitness for a particular purpose, functionality, data integrity or protection. Trademarks JAM and 'The JAM Real-Time Data Compression Utilities' are trademarks of JAM Software. IBM/PC/XT/AT, PS/1, PS/2, PC-DOS and IBM-DOS are trademarks of International Business Machines Corp. MS-DOS, Windows, Windows-NT are trademarks of Microsoft Corporation. DR-DOS is a trademark of Digital Research Inc. Novell DOS is a trademark of Novell, Inc. Trademarks of other companies mentioned in this documentation appear for identification purposes only and are the property of their respective companies. JAM 1.10 User's Guide Page 2 ------------------------------------------------------------------------ Table of Contents ===================== How to Use This Guide . . . . . . . . . . . . . . . . . . . . . . 4 Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . 7 1.1. What is the JAM? . . . . . . . . . . . . . . . . . . . . 7 1.2. Basic concepts of the JAM . . . . . . . . . . . . . . . 9 Chapter 2. Getting Started With the JAM . . . . . . . . . . . . 11 2.1. Before you begin . . . . . . . . . . . . . . . . . . . . 11 2.2. Installing the JAM on your hard disk . . . . . . . . . . 12 2.3. Creating JAM Archive File . . . . . . . . . . . . . . . 13 2.4. Installing the JAM device driver . . . . . . . . . . . . 14 Chapter 3. Using the JAM . . . . . . . . . . . . . . . . . . . 15 3.1. General . . . . . . . . . . . . . . . . . . . . . . . . 15 3.2. Viewing the contents of the JAM Drives . . . . . . . . . 16 3.3. Extended JAM Drive statistics and utilization . . . . . 18 3.4. Optimizing JAM Drives . . . . . . . . . . . . . . . . . 19 3.5. UnDelete operation support . . . . . . . . . . . . . . . 20 Chapter 4. Command Reference . . . . . . . . . . . . . . . . . 21 4.1. The JCREATE utility . . . . . . . . . . . . . . . . . . 21 4.2. The JAM device driver . . . . . . . . . . . . . . . . . 27 4.3. The JMOUNT utility . . . . . . . . . . . . . . . . . . . 31 4.4. The JDIR utility . . . . . . . . . . . . . . . . . . . . 40 4.5. The JCHKDSK utility . . . . . . . . . . . . . . . . . . 50 4.6. The JMAX utility . . . . . . . . . . . . . . . . . . . . 63 Chapter 5. Guidelines for efficient use of the JAM Drives . . . 67 Chapter 6. F.A.Q. (Frequently Asked Questions) . . . . . . . . 70 Appendix A. Glossary . . . . . . . . . . . . . . . . . . . . . . 73 JAM 1.10 User's Guide Page 3 ------------------------------------------------------------------------ Appendix B. JAM technical information . . . . . . . . . . . . . 79 B.1. JAM Drive Structure . . . . . . . . . . . . . . . . . . 79 B.2. JAM device driver . . . . . . . . . . . . . . . . . . . 83 B.3. JAM Application Interface . . . . . . . . . . . . . . . 87 I n d e x . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 JAM 1.10 User's Guide Page 4 ------------------------------------------------------------------------ How to Use This Guide =========================== This guide was designed for three different types of users: Average those who are typical, average computer users (including beginners) who would like to know just enough about a product to use its basic function properly Advanced those who have computer experience and who would like to learn how to use the products advanced functions Expert those who consider themselves computer experts and who would like to know everything about a software product Most computer users belong to the Average category. Usually, they use a standard personal computer system equipped with one hard disk, a printer, and productivity software (such as a word-processor or a spreadsheet package). The JAM in its basic and most common configuration was designed with the typical needs of the average user in mind. There is no need to read the entire manual to understand the principles of the product, to install it, or to use it almost immediately. The minimum you need to read to get started is Chapter 2 - Getting Started With the JAM. An overview of the guide's contents is presented on the following pages. JAM 1.10 User's Guide Page 5 ------------------------------------------------------------------------ Chapter 1 - Introduction In this chapter you will find a brief introduction to the features, benefits, and basic concepts of the JAM package. No prior knowledge or experience is required to understand this chapter, though the user should have a basic understanding of DOS (either PC-DOS, MS-DOS, DR-DOS, or Novell-DOS). For more information regarding the DOS, refer to your Operating System User's Guide. Intended readers: All JAM users. Chapter 2 - Getting Started With the JAM By following a few simple installation instructions as presented in this chapter, you will be able to create your first JAM drive and have it ready for use in less than five minutes. Intended readers: All JAM users. Chapter 3 - Using the JAM This chapter summarizes all that you need to know for the day-to-day operation of the JAM. The chapter informs you how to obtain detailed information about the contents of the JAM drive, and how to verify and optimize it. Intended readers: All JAM users. Chapter 4 - Command Reference This chapter consists of detailed information about components of the JAM package. For each program you will find full command-line syntax, notes regarding its advanced features, and finally -- listing and explanation of all error messages. Intended readers: Advanced and Expert Users. Chapter 5 - Guidelines for efficient use of the JAM Drives In this chapter you will find practical guidelines and useful hints for efficient use of the JAM drives with your application software. Intended readers: Advanced and Expert Users. JAM 1.10 User's Guide Page 6 ------------------------------------------------------------------------ Chapter 6 - F.A.Q. (Frequently Asked Questions) This chapter consists of some frequently asked questions concerning the JAM package and the answers. Intended readers: All JAM users. Appendix A - Glossary This appendix defines many of the key terms used throughout the manual and outlines the principles and differences between the various types of disk drives, and file organization under DOS and JAM. It is highly recommended even for average users to read this appendix and become more familiar with these principles and terms. After reading this section, you will have a better understanding of what the software does and how to use it more effectively. Intended readers: All JAM users. Appendix B - The JAM technical information This appendix provides an explanation about some technical aspects of the JAM. While mainly general information is supplied, several hints are included that may also help the more advanced users in non-standard activities (e.g. use of external utility programs with the JAM drives, etc.). Intended readers: Expert Users. JAM 1.10 User's Guide Page 7 ------------------------------------------------------------------------ Chapter 1. Introduction ============================= 1.1. What is the JAM? JAM is a transparent hard disk compressor, which enlarges your disk space. With the JAM you will forget about annoying messages like 'Insufficient disk space...' with no need to purchase a new hard disk. JAM includes: * a fast and powerful disk driver, which 'squeezes' your data before writing it to disk and extracts them while reading * a set of utilities (including the troubleshooting one) making your work with the compressed disk pleasant and safe Why use the JAM? You will like the JAM because it provides: * a high speed of data compression and extraction, even higher than that your hard disk has now. You don't have to sacrifice the performance of your computer to the new disk size! * an approximately 2.5 (two and half) - time (!) increase of your disk space. You can even enhance this ratio, having optimized your compressed disk using the JMAX utility * a minimal RAM space required for the JAM-driver (24K or 32K bytes) * a possibility to load the JAM-driver into high memory * a full usage of the resources of the Intel 80386/486 and Pentium processors, working fast enough even on the Intel 80186 * a full compatibility with the software you use, such as Norton Utilities, PCTOOLS, DOS-based LANs, etc. You should not keep in mind that the JAM is working on your computer * a set of the JAM - specific disk utilities, including disk optimizer JMAX, the disk information program JDIR, and a 'doctor' of your compressed disk JCHKDSK * and many other advantages ... JAM 1.10 User's Guide Page 8 ------------------------------------------------------------------------ Speed of the JAM As a rule, the real-time disk compressors impair considerably the overall computer performance. But the JAM doesn't! It uses an effective algorithm of compression and extraction, which allows you to enlarge your disk space without any major slowdown of your system. The built-in reliable cache system provides high performance and full safety for your data. As a result, the write speed for the JAM-compressed disk is only slightly lower than the intrinsic hard disk speed, while the read speed is higher than that of your hard disk. The compression ratio The JAM incorporates several effective algorithms making it possible to achieve at least 2:1 compression. Having optimized your compressed disk by the JMAX utility, you can attain the ratio of 3.0 - 5.0. The JDIR program will inform you on how well the data is compressed. The compatibility of the JAM with other disk utilities The JAM is fully compatible with any well-known disk utility. You can use any program from the Norton Utilities, Mace Utilities, PCTOOLS (to say nothing about standard DOS disk utilities) without any harm to the data on your compressed disk. The JAM will not conflict even with the undelete features like the EraseProtect and UnErase. How much RAM space does the JAM-driver need? Minimum! 32K bytes if you use the 8K clusters, or just 24K bytes if you prefer to use JAM drives with 4K cluster size. Moreover, you can load the JAM-driver into high memory, thus, free some room in conventional memory used by DOS. System requirements * an IBM PC/XT/AT, PS/1, PS/2, or compatible computer with an Intel 80188/186+ or NEC V20/30 processor * PC-DOS/MS-DOS 3.30 - 7.0, DR-DOS 6.0, or Novell DOS 7 * and - of course - a hard disk! JAM 1.10 User's Guide Page 9 ------------------------------------------------------------------------ 1.2. Basic concepts of the JAM Using the JAM, it is possible to compress either the whole disk or a part of it. In both cases the compressed information is presented as a file called the JAM Archive File. The file can have any name with the ".JAM" extension and attributes making it inaccessible to modification. Only the JAM driver will work with JAM archives. The JAM driver is loaded while the system initialization and is presented as one or more Logical Drives, each of them being assigned to an Archive File represents data on it as a standard DOS Disk Drive. The amount of space on existing hard disk (called the Host Drive) which is occupied by the JAM Archive is called the Physical Capacity of the JAM drive. Physical capacity is, on average, only 40% (1 : 2.5) of the JAM Drive size reported by DOS. This value (called Logical Capacity of the JAM drive) means the largest quantity of data which may be stored on a Logical Drive. ,---------------------------. : JAM Device Driver : :---------------------------: DOS Hard Disk Drives: : JAM Logical Drives: : +----+ +----+ +----+ : +----+ +----+ +----+ : | C: | | D: | ... | I: | /---->| J: | | K: | | L: | ... : +----+ +----+ +----+ | : +----+ +----+ +----+ : || | `----||---------------------' __\/_____________________ | __\/____________________ +------------------------.| | +-----------------------.| | Hard Disk Drive C: || | | JAM Logical Drive J: || |------------------------|| | |-----------------------|| |... || | | Drive size = Log.cap. || |datafile1 || | | = 2.5 * Phys.cap. || |datafile2 || | |-----------------------|| |... || | |... || |DISK1.JAM JAM Archive >-----/ |bigdatafile1 || | (Compressed Data) || |bigdatafile2 || | File size = Phys.cap. || |... || |... || |... || +------------------------+ +-----------------------+ For example, if you create on your Host Drive (say, drive C:) a JAM Archive file (say, file DISK1.JAM) with a size of 40M bytes, you will have a JAM drive (say, drive J:) with a Logical Capacity of 100M bytes. JAM 1.10 User's Guide Page 10 ------------------------------------------------------------------------ Nevertheless, the REAL amount of the data that can be stored on a JAM Drive (called Actual JAM Drive Capacity) directly relates to Average Compression Ratio achieved on it and Physical Capacity of the JAM Drive. To provide you with the most likely amount of Actual Space Available on a JAM Drive at any given moment, the JAM driver reports to application programs its own Free Space estimate. This value (called Projected Free Space) is based on current Average Compression Ratio and both Physical and Logical Free Space available on a JAM Drive. So, for example, the DOS DIR command being run on a JAM drive will always tell you Projected Free Space. To get extended JAM Drive statistics, including both Logical and Physical parameters you may use JCHKDSK utility. Further detailed considerations regarding JAM Drives statistics and utilization are presented in Chapter 3. Using the JAM. JAM 1.10 User's Guide Page 11 ------------------------------------------------------------------------ Chapter 2. Getting Started With the JAM ============================================= 2.1. Before you begin Before you begin the installation and use of the JAM, you must check that the following system requirements are met: * an IBM PC/XT/AT, PS/1, PS/2, or compatible computer with an Intel 80188/186+ or NEC V20/30 processor * PC-DOS/MS-DOS 3.30 - 7.0, DR-DOS 6.0, or Novell DOS 7 * and at least one hard disk. NOTE: It is highly recommended to run a Disk Defragmentation utility on your hard disk system (e.g. Gazelle Systems' OPTune, Golden Bow's VOPT, Central Point Software's COMPRESS, Norton Utilities' SPEEDISK (MS-DOS 6.0+ DEFRAG) and alike) BEFORE installing the JAM, as it may greatly improve system performance. JAM 1.10 User's Guide Page 12 ------------------------------------------------------------------------ 2.2. Installing the JAM on your hard disk Your computer should be turned on and at the DOS prompt. If your computer normally runs a program automatically when you turn it on, you will need to exit from this program. You should have a prompt on your screen similar to: C:\> Insert the diskette containing the original JAM distribution in your floppy drive, either A: or B:. Next, create a subdirectory for JAM on your hard drive. To do so type: C:\>MD JAM Then change to this subdirectory. C:\>CD JAM C:\JAM> Now enter the name of the self-extracting archive file on your JAM disk, include the drive letter as part of the name. C:\JAM>A:JAM110 Note that the name of the self-extractor used throughout this manual (JAM110.EXE) may vary but will follow the pattern of JAM###.EXE where ### represents the version number of the software. The contents of this file will now extract into the JAM subdirectory. The A: and C: drives in the above command are only for example, and may be replaced with other drive letters as appropriate to your particular setup. You should next modify your AUTOEXEC.BAT file. You can edit this file with any editor that can load and save DOS TEXT or plain ASCII files (For example, "edit" in DOS 5.0, Windows Write, or any word processor with a DOS TEXT editing ability). If you have DOS 5.0 type: C:\>EDIT AUTOEXEC.BAT Look for a line in the file that says something similar to: PATH=C:\;C:\DOS;(etc...) Go to the end of this line and add a semicolon if one is not already there, and the drive and path to the JAM that you just created. For example "...;C:\JAM" JAM 1.10 User's Guide Page 13 ------------------------------------------------------------------------ The line will now look like this: PATH=C:\;C:\DOS;C:\JAM You will most likely have additional items between the C:\DOS; and C:\JAM. Save the file and exit. You will have to re-boot your computer so that the changes take effect. After you reboot type "path" at the command line and press [ENTER]. Your machine will show the path. Make sure that the subdirectory you placed the JAM files in is shown in the path. 2.3. Creating JAM Archive File Now, you should find an appropriate Host Drive. This is the physical drive on which you will create the JAM Archive File (You may refer to Appendix A in this manual to get familiar with the JAM terminology). Then look how much free space has your Host Drive (say, drive D:), using, for example the DOS's DIR command: C:\>DIR D: and determine amount of it you want to compress (in an example below we will allocate 1000K bytes for the JAM Archive File). Please note, that amount of space you can define as a JAM Archive should not be less than 72K bytes and not greater than 512M bytes. Finally, you should assign the name for new JAM File to create (say, FIRST) and type: C:\>JCREATE D:FIRST /A /S=1000 When this program finishes work it gives a display similar to this: JCREATE 1.10 Copyright (c) JAM Software, 1992-1994. All rights reserved. JAM file: D:\FIRST.JAM 512 bytes in boot sector + 1536 bytes in JAM descriptor table + 512 bytes in file allocation table(s) + 8192 bytes in root directory + 2531328 logical / 1012224 physical bytes available for files --------------------------------------------------------------- 2542080 logical / 1022976 physical bytes total on archive 40.0% (2.5 / 1.0) anticipated compression ratio JAM 1.10 User's Guide Page 14 ------------------------------------------------------------------------ You may now verify that new JAM Archive is created. Type: C:\>JDIR D:FIRST /A /Q at the DOS command prompt. After you press [ENTER] you should see a screen like: Volume in drive D: has no label Directory of D:\ FIRST JAM 1022976 04-01-94 8:00p 1 File(s) 1022976 bytes 3956736 bytes free 2.4. Installing the JAM device driver Next, you should modify your CONFIG.SYS file. Here you also can edit this file with any text editor. If you have DOS 5.0 type: C:\>EDIT CONFIG.SYS and insert two lines at the top of file: DEVICE=C:\JAM\JAM.SYS DEVICE=C:\JAM\JMOUNT.COM D:\FIRST Note, that the C:\JAM directory and D:\FIRST JAM Archive File name in the lines above are only for example, and may be replaced with other names as appropriate to your particular setup. Save the file and exit. In order to start using the JAM Drive you have just created, you will have to re-boot your computer at this time. YOUR FIRST JAM DRIVE IS READY FOR IMMEDIATE USE. GOOD LUCK! JAM 1.10 User's Guide Page 15 ------------------------------------------------------------------------ Chapter 3. Using the JAM =============================== 3.1. General From the user's point of view, the JAM drive may be regarded as a standard DOS drive operating like any other drive in the system. You may use any DOS command such as COPY, DEL, or DIR with it, use it as a file directory for your word-processing or spreadsheet software, store archive and historical information in it to save space, or even store program files (those with the .EXE or .COM extension) and run them from the JAM Logical Drive. You may use your applications with the JAM drive without any alterations, just as with a standard drive. The JAM software operates behind the scenes in a completely transparent manner. As far as you are concerned, the information is stored and retrieved from the JAM drive as though it was a standard disk drive, without any external interventions, except for one significant difference: the information stored on the JAM drive takes up on average 40% of the space the same information would occupy on a standard DOS disk drive. JAM 1.10 User's Guide Page 16 ------------------------------------------------------------------------ 3.2. Viewing the contents of the JAM Drives You may use the DOS DIR command to view the contents of the JAM Drives. However, in some cases, you may also need to know how well the files on the JAM drive are compressed (or in other words -- how much physical space they use). To obtain accurate information regarding the JAM Drive contents and status (which cannot be obtained from DOS or any other external utility), you must use the JAM JDIR command. The syntax of the JDIR (see Chapter 4 - Command Reference for details) is almost the same as DOS DIR command, except for /C switch -- allowing you to show the files' and average Compression Ratio on the JAM Drive. For example, the command: JDIR J:\WINDOWS\*.DLL /C will produce the screen like: JDIR 1.10 Copyright (C) JAM Software, 1992-1994. All rights reserved. Volume in drive J: is WINDOWS Directory of J:\WINDOWS CARDS DLL 148528 09-13-91 4:30p 26.64% MGRLIB DLL 29712 06-01-92 3:50p 43.75% MORICONS DLL 118864 03-10-92 3:10a 29.17% PBRUSH DLL 6766 03-10-92 3:10a 62.50% RECORDER DLL 10414 03-10-92 3:10a 46.88% WEPUTIL DLL 19200 09-13-91 4:30p 39.58% 31.68% average compression ratio 6 File(s) 333484 bytes 1238450 bytes free The Compression Ratio is calculated based on the Logical and Physical space occupied by file (or by group of files): Physical Bytes Allocated Compression Ratio = 100 * ---------------------------- Logical Bytes Allocated (Refer to Appendix A in this manual to get familiar with DOS and JAM file organization). JAM 1.10 User's Guide Page 17 ------------------------------------------------------------------------ Thus file MORICONS.DLL (on example above) on Logical level occupies 15 8K bytes' clusters (i.e. 15 * 8K = 120K = 116K(file size) + 4K(slack)), but its Physical (compressed) size is only: Compression Ratio * Logical Size 29.17 * 120K ------------------------------------ = -------------- = 35K. 100 100 Note, that the JDIR calculates and reports summary information only for the files which were specified in the search criteria (in the example above we have used *.DLL file specification). To determine the Overall Compression Ratio of a JAM Drive, type: JDIR J:\*.* /S (switch /S makes files in all subdirectories included in the listing). JAM 1.10 User's Guide Page 18 ------------------------------------------------------------------------ 3.3. Extended JAM Drive statistics and utilization The JCHKDSK utility program verifies the integrity of the JAM Drive, and provides you with statistical information regarding the overall disk usage, utilization, Compression Ratio, and the Logical, Physical and Projected Free Space currently available. JCHKDSK displays a status report similar to the following example: Volume in drive D: is WINDOWS Volume Serial Number is 11D1-223F JAM logical drive D: JAM file: C:\JAM\MNT\WINDOWS.JAM 150142976 bytes total disk space 60057088 bytes total archive space 81920 bytes in 2 hidden files 59392 bytes in 2 hidden files 1654784 bytes in 202 directories 1654784 bytes in 202 directories 113655808 bytes in 2824 user files 53265920 bytes in 2824 user files 34750464 bytes available on disk 5078016 bytes free on archive 47.65% average compression ratio (2.1:1) 7577600 bytes projected free space 655360 bytes total memory 400592 bytes available memory The data on the left half of the screen shows the JAM Logical Drive usage, the data on the right side -- JAM Archive File information (Physical space usage). The Projected Free Space is calculated based on the Physical Total Space, Logical and Physical Free Space reported. The recalculation formulae is: Projected Free Space = Log.Free Space * Xi + Phys.Free Space * (1 - Xi), Physical Free Space where: Xi = -------------------------- Physical Total Space is the Physical Space Usage Ratio. When archive is empty, Xi is equal 1 and Projected Free Space is equal to Logical Free Space. Otherwise, when archive is almost full, Xi comes to 0, and Projected Free Space will be near to Physical Free Space. The JAM driver also calculates the Projected Free Space and uses it to replace the Logical Free Space value reported by DOS. Thus, almost all application programs (for example Windows File Manager, XTreeGold, Norton Commander, or standard DOS DIR command) will always display recalculated number of bytes available on JAM drives, providing you with the most likely amount of space you will use. JAM 1.10 User's Guide Page 19 ------------------------------------------------------------------------ 3.4. Optimizing JAM Drives Like for a standard DOS drive, extended reading and writing of a JAM compressed drive may cause diminished performance due to scattering of the data throughout the disk. To eliminate this problem on a standard disk drive you may run a standard DISK DEFRAGMENTATION UTILITY (e.g Central Point Software's COMPRESS, Norton Utilities' SPEEDISK (MS-DOS 6.0+ DEFRAG) and alike). Although having run standard defragmentation utility on a JAM drive, you will probably NOT improve your system's performance (*). To perform TRUE (and completely SAFE) optimization of the JAM compressed drive, you should run a JMAX utility, which comes with the JAM package. This utility provides several types of disk optimizations, including ReCompression, and Defragmentation of data on the JAM File. ReCompress - packs JAM compressed files tigther to give you up to 40% (!) more available space on your compressed drive. In addition, this optimization can significantly increase speed of the data extraction, and as a result, your disk will work up to 10-20% faster (!). Defragment - places all data of the files in consecutive sectors on the disk. For example, to optimize JAM drive J, you would type the following at the command prompt: JMAX J: To optimize the current drive, type the following command: JMAX Note that JMAX utility is quite smart - it would not do its job for a second time. So, you can recompress your JAM drive on weekly or even daily basis, not worrying about long time it takes to execute - if you have changed only one file on your JAM disk, JMAX would recompress only this file. ---------- (*) The point is that data organization on the JAM Archive File is NOT the same as on the JAM Logical Drive (see Appendix B. for details), and to write data on the JAM drive, JAM.SYS uses own (specific for variable- length blocks) allocation algorithm. In other words, when standard defragmenter calls the JAM driver to write some data to a certain location on the Logical Drive, JAM.SYS will compress and write it to the first appropriate block of currently available (unallocated) sectors on the Archive File. As a result, we will have a JAM Drive with well orga- nized logical structure, and highly fragmented data on physical level. Moreover, when the JAM archive file is almost full, such defragmenters may actually DAMAGE the compressed data (most of them simply cannot handle device errors correctly -- they modify the FAT and directory information, even if file's data(clusters) have not been written). JAM 1.10 User's Guide Page 20 ------------------------------------------------------------------------ 3.5. UnDelete operation support The JAM package enables you to use utility programs (e.g. MS-DOS's (Central Point Software's) Undelete, Norton Utilities' Quick-Unerase, etc.) to perform UnDelete operations on erased files residing on JAM drives. For each logical drive, the JAM driver maintains a special [DirectWrite] flag which is essential for proper UnDelete utilities operation (specifically, being set to ON it enables Direct Write operations, used by certain low-level disk programs, including UnDelete utility). By default, this flag is set to OFF, and this should be normal setting. This flag should be set to ON before attempting to UnDelete files on the JAM drive, then it should be reset to OFF. To show and modify current status of the [DirectWrite] flag for some specified JAM drive (say, drive J:), you should use the JMOUNT utility. Before using the UnDelete utilities, issue the following command: JMOUNT J: /W+D Now you can perform the UnDelete activities as desired. After these activities are completed, issue the following command: JMOUNT J: /W-D Executing JMOUNT without any parameters will report the JAM drives list including current [DirectWrite] flag status. Further detailed considerations regarding the JMOUNT utility, special UnDelete-compatible mode, and other JAM drive flags are presented in Section 4.3 "The JMOUNT Utility". JAM 1.10 User's Guide Page 21 ------------------------------------------------------------------------ Chapter 4. Command Reference ================================== This chapter consists of summary information about the JAM device driver and the other JAM utilities. For each program, full command-line syntax, notes regarding some advanced features, listing and explanation of all error messages are provided. 4.1. The JCREATE utility ---------------------------- Creates an empty JAM Archive file by using free space on an uncompres- sed drive. Being mounted as a JAM drive, Archive File will provide more storage capacity than the amount of space it uses. Syntax JCREATE [drive:][\][path\]filename[.ext] [/A[:][attributes]] [/S=size] [/R=ratio] [/C=clustsiz] [/F=fats] [/D=dirsiz] [/V[label]] or DEVICE=[drive2:][\][path2\]JCREATE.COM [drive:][\][path\]filename[.ext] [/A[:][attributes]] [/S=size] [/R=ratio] [/C=clustsiz] [/F=fats] [/D=dirsiz] [/V[label]] Parameters [drive:][\][path\] Full or relative path of the file to create. This is optional part of the name of file to create. If you omit it, JCREATE uses current DOS drive/directory to create file. In any case drive that contains the space you want to use to create new drive SHOULD BE UNCOMPRESSED. filename[.ext] Specifies the name of the JAM file to create. If you omit the filename extension, JCREATE uses ".JAM". [drive2:][\][path2\] Specifies the location of the JCREATE.COM file. JAM 1.10 User's Guide Page 22 ------------------------------------------------------------------------ Switches /A[:][attributes] Specifies attributes to be assigned to the new JAM Archive file. If you omit this switch, JCREATE clears all file attributes except for read-only flag. If you use this switch without specifying attributes, JCREATE sets system, hidden and read-only flags to prevent Archive File removing, modification and physical reallocation by disk-optimizing programs. The following list describes each of the values you can use for attributes. The colon (:) is optional. Use any combination of these values, and do not separate the values with spaces. +H or H Makes file hidden (unmovable during disk optimization) -H Makes file visible +S or S Makes a system file -S Removes system flag +A or A Make file ready for archiving (backup) -A Prohibits file archiving +R or R Makes file read-only -R Makes file accessible for modifications /S=size Amount of space in K-bytes (72 <= size <= 524288) to allocate for the JAM Archive File. If you omit this switch, JCREATE uses all available space on drive for the file. /R=ratio Sets maximum logical size of the JAM Archive by specifying an anticipated compression ratio (percentage of compressed size / original size): ratio = 100 % -> 1.0:1 (zero compression), ... , ratio = 40 % -> 2.5:1 (default value for compression ratio), ... , ratio = 10 % ->10.0:1 (maximum compression). /C=clustsiz Sets cluster size, in K-bytes, for the JAM Archive File. Using this switch you may specify either 4K or 8K (default value) clusters. JAM 1.10 User's Guide Page 23 ------------------------------------------------------------------------ /F=fats Sets the number of FAT (DOS File Allocation Table) copies. If you omit this switch JCREATE initializes one File Allocation Table on new JAM Archive File. If your system does not work with disk drives having only one FAT, you need to set this parameter to 2. /D=dirsiz Sets the maximum number of root directory entries. Values supported are: 64, 128, 256, or 512. If you omit this switch JCREATE initializes 256 entries in root directory. /V[label] Specifies the JAM-drive volume label. If you use this switch without specifying name to be assigned to volume label, JCREATE doesn't create label on new JAM Archive. If you omit this switch, JCREATE uses filename string to make volume label. /Q Quiet mode (does not display status messages). Notes Before you run JCREATE ... It is strongly recommended TO TEST AND DEFRAGMENT your disk BEFORE you create any archive file. By doing so you will avoid numerous possible problems, and ensure maximum performance of compressed drive you will create. JAM Archive File attributes Using JCREATE with /A switch will also protect your new Archive file from occasionally removing, modification and physical reallocation. Do not use DISK DEFRAGMENTATION UTILITIES (e.g Central Point Software's COMPRESS, Norton Utilities' SPEEDISK (MS-DOS 6.0+ DEFRAG) and alike) when you have mounted JAM Archive files which do not have HIDDEN and/or SYSTEM attribute set. Doing so can result in relocating compressed JAM volumes without noticing JAM driver, thus causing serious data loss and corruption. Either UNMOUNT JAM Archives prior to disk optimization (see Section 4.3. for details) or give them HIDDEN attribute with JCREATE or DOS ATTRIB program. Archives with 4K and 8K bytes clusters Using JCREATE you may initialize JAM archives with either 4K or 8K clusters. The main advantage of archives with 4K bytes clusters is possibility to load JAM driver with small buffers (see JAM.SYS /C switch). In this case JAM.SYS will need only 24K bytes of memory to work with such archive. Opposite reason is the better compression ratio (usually +5..10%) achieved on drives with 8K bytes clusters. JAM 1.10 User's Guide Page 24 ------------------------------------------------------------------------ Initializing RAM drive for compression Using the JAM it is possible to enlarge size of the RAM-drive on your PC as well as its hard-disk capacity. To do it you should simply create JAM Archive File on your RAM disk and then mount it as a JAM drive. To allow you perform all these steps in the most convenient way, we made file JCREATE.COM both an executable program and a device driver. An example of running JCREATE from CONFIG.SYS file is given below. Examples To create a new JAM Archive file that uses all available space on uncompressed drive E, type the following command: JCREATE E:TEST1 To create a new JAM Archive File by using 10 MB of space on uncompressed drive E, type the following command: JCREATE E:TEST2 /s=10240 To create a new JAM Archive File by using 10M of space on uncompressed drive E, and to direct the JAM driver to recalculate space on them using anticipated compression ratio 25% (4.0 to 1), type the following command: JCREATE E:TEST3 /s=10240 /r=25 To initialize RAM-drive R: for compression during system start-up, you may add the following line into your CONFIG.SYS file: DEVICE=C:\JAM\JCREATE.COM /Q R:\RAM-DISK.JAM (switch /Q prevents display status messages on your display). JAM 1.10 User's Guide Page 25 ------------------------------------------------------------------------ Error messages 1. Incorrect DOS version. PC-DOS/MS-DOS 3.30-7.0, DR-DOS 6.0, or Novell DOS 7 required. The JAM has NOT been tested with version of DOS that your computer has now. JAM 1.10 supports only PC-DOS/MS-DOS 3.30-7.0, DR-DOS 6.0 and Novell DOS 7. If you have newer release of MS-DOS /PC-DOS or Novell DOS, please contact us for update information. 2. Invalid switch: /xxx 3. Incorrect parameter: /<switch>=xxxxx Specified switch is not supported by JCREATE or specified value is out of range. Run JCREATE/? for help. 4. Invalid (or MS-DOS reserved) file name: xxxxxxxxx Specified filename cannot be resolved to fully qualified form (drive:\path\filename.ext). You may receive this message if specified drive does not exist, path\filename was spelled incorrectly, or if you have specified some MS-DOS reserved name (for example, PRN, CON, NUL, CLOCK$ ...). 5. Name of the JAM-file expected Name of the JAM-file was omitted or spelled incorrectly. To create new Archive File using JCREATE, you should specify file name as an essential parameter. 6. File xxxxxxxx already exists Specified file already exist. You should use another name (path), or delete existing file if you have just created it by running JCREATE with wrong parameters. 7. Invalid drive specification z: Specified path/filename points to drive that actually does not exist. 8. There are only xxxxxxx bytes free on drive z: Specified file size (/S parameter), is larger than amount of free space on drive you want to use to create Archive File. JAM 1.10 User's Guide Page 26 ------------------------------------------------------------------------ 9. Logical drive size too big (> XXX Mbytes) Try to specify smaller physical size (/S), or anticipated compression ratio (/R) Specified combination of /C, /S and /R parameters produces too big logical drive size. Because number of clusters on standard DOS drives cannot be greater than 65526 (hex FFF6), maximum logical sizes of JAM drives with 4K and 8K clusters are 256M and 512M bytes respectively. Try to specify larger cluster size (/C switch), or smaller physical size (/S switch), or larger anticipated compression ratio in terms of space usage (/R switch). 10. ... cannot create file 11. ... unable to write 12. ... cannot close file These errors may appear during Archive File creation process. They mean your target disk/directory is full or you have problems with physical writing on your disk. Try to run NDD or ScanDisk to test your disk. 13. ... -> JCREATE aborted Control-c or control-break was pressed. JAM 1.10 User's Guide Page 27 ------------------------------------------------------------------------ 4.2. The JAM device driver ------------------------------ The JAM device driver is a utility that provides access to your compressed drives. To initialize it you should add the DEVICE command for JAM.SYS driver to your CONFIG.SYS file. Also you may use DOS's DEVICEHIGH command or special LOADHI (HILOAD) programs (supplied with QEMM or 386MAX packages) to load JAM.SYS to upper memory. Syntax DEVICE=[drive:][\][path\]JAM.SYS [/M=maxmount] [/C=clustsiz] [/A=allocbufs] [/B=clustbufs] or DEVICEHIGH=[drive:][\][path\]JAM.SYS [/M=maxmount] [/C=clustsiz] [/A=allocbufs] [/B=clustbufs] Parameter [drive:][\][path\] Specifies the location of the JAM.SYS file. Switches /M=maxmount Specifies the number of mountable JAM drives. If you omit this switch, JAM.SYS initializes only one drive, that will be assigned to first available drive letter in DOS drive list. If you need to mount more than one JAM Archive File, you should specify the number of your files next to the /M= switch. JAM.SYS is able to support up to ten drives at the same time. /C=clustsiz Specifies maximum cluster size (in Kbytes) of all JAM files to be mounted. If you omit this switch JAM.SYS will support Archives with either 4K or 8K clusters. If you need to mount JAM Files with only 4K clusters you may set this parameter to 4. This will allow you reduce size of the JAM driver in memory by 8K. More detailed information concerning memory consumption is given below. /A=allocbufs Specifies the number of Allocation Buffers. These buffers JAM.SYS uses to speed-up access to JDTs (JAM drive Descriptor Table) on mounted Archive Files. By default the JAM driver uses one allocation buffer. /B=clustbufs Specifies the number of Data Buffers. JAM.SYS uses these buffers to speed-up access to compressed clusters on mounted Archive Files. If you omit this switch JAM driver will use one buffer for compressible data. JAM 1.10 User's Guide Page 28 ------------------------------------------------------------------------ Notes JAM.SYS and JMOUNT.COM Unlike other real-time compressors (e.g. SuperStor or Stacker) the JAM driver DOES NOT MOUNT ARCHIVE FILES AUTOMATICALLY. This means, that any attempts to read from /write to a JAM drive will cause "Device not ready" error (like when you forget to insert diskette in floppy- drive), until you ASSIGN this drive to a JAM Archive file. To perform such assignment you should run JMOUNT utility (either immediately after loading JAM.SYS in CONFIG.SYS file or whenever else). Loading programs from JAM-drives during system start-up If you want to run a program that is placed on the JAM-drive from your CONFIG.SYS or AUTOEXEC.BAT files, you should be sure that JAM.SYS was installed and assigned to corresponding Archive File BEFORE you call your program. Otherwise you will get error message like "Unrecognized command in CONFIG.SYS" or "Bad command or file name". In any case, you should NOT move system files: IO.SYS (or IBMIO.COM in PC-DOS or DR-DOS), MSDOS.SYS (or IBMDOS.COM), HIMEM.SYS (or HIDOS.SYS), EMM386.SYS (or any other Expanded Memory Manager that you use), configuration information such as CONFIG.SYS, and files JAM.SYS and JMOUNT.COM to the JAM drive. JAM.SYS switches and their influence on memory consumption The following table describes JAM.SYS memory usage: -----------------------+--------------+------------------------------- Object | Parameter | Object Size | | clustsiz = 8K clustsiz = 4K -----------------------+--------------+---------------+--------------- Driver itself | ----- | 22.3K | 18.3K Each drive supported | /M=maxmount | 1.2K | 1.2K Each allocation buffer | /A=allocbufs | 0.5K | 0.5K Each cluster buffer | /B=clustbufs | 8K | 4K -----------------------+--------------+---------------+--------------- Total: 14.3K + 1.2K * maxmount + 0.5K * allocbufs + 1K * (clustbufs +1) * clustsiz Using internal cache system To increase compressed drives performance, JAM.SYS uses two sets of disk buffers. The first ones are used to speed-up access to JDTs (JAM Drive Descriptor Table) on mounted Archive Files. Each allocation buffer has 512 bytes (1 sector) of length and may consist of up to 128 clusters' descriptors. It's quite enough to work with drives, whose overall size is less than 10M. But, if your JAM drives have a large capacity, you should enlarge this value. To choose the most suitable to your system number of allocation buffers, use the following table: JAM 1.10 User's Guide Page 29 ------------------------------------------------------------------------ ---------------------+------------------------------------------------ JAM drive capacity | Recommended number of Allocation Buffers | clustsiz = 8K clustsiz = 4K ---------------------+------------------------+----------------------- <= 20M | 4 | 8 <= 40M | 8 | 16 <= 70M | 15 | 30 <= 100M | 25 | 45 >= 200M | you should set /A=2 and use external disk cache ---------------------+------------------------+----------------------- The second set of buffers JAM.SYS uses to speed-up access to compressed data on mounted Archive Files. These buffers contain EXPANDED data of clusters that have been read from or that will be written to the disk. Size of each data buffer is equal to maximum cluster size supported by the JAM driver and may be 4K or 8K bytes. So, using large number of data buffers, you will take a lot of memory from DOS. We recommend you to choose number of data buffers in range from 1 to 8 in accordance with your speed/memory requirements. Using external disk caches The built-in JAM.SYS cache system provides speed-up only for your compressed drives. Moreover, the JAM driver cache DOES NOT SUPPORT background disk writing, reordering low-level i/o requests, special hard disk read/write modes, and other advanced methods of disk performance improvement that do not guarantee full safety for your data. In other words, the JAM.SYS internal cache system could not completely replace a standard disk cache utility, e.g. SMARTDrive, HyperDisk, Super PC-Kwik (or its OEMs: PC-Cache and Qualitas Qcache), NCACHE2, etc. So, if you have one of these programs running with the JAM, you should release some memory by resetting JAM.SYS's /A and /B switches. The number of allocation buffers (/A switch) should not be larger than number of currently supported JAM drives. The number of data buffers (/B switch) may be 1. Some modern disk caches (like SMARTdrive 4.0+, NCACHE2, NWCACHE, etc.) intercept (and/or reorganize) requests to all (existing at the moment of the cache initialization) DOS block device drivers, including the JAM ones. This means, that the data on the JAM drives would be cached TWICE: 1. When DOS reads Original Data from/ writes to a JAM drive, 2. When JAM driver reads Compressed Data from/ writes to a Host drive for the JAM Archive. To prevent this effect (and to make work with your compressed data more reliable) you should load your disk cache BEFORE JAM.SYS driver, thus leaving only the second way for caching JAM drives. JAM 1.10 User's Guide Page 30 ------------------------------------------------------------------------ In addition, you can get additional speed-up for compressed drives even if you use an external disk cache. The point is that external cache program holds some data from physical disk (you CANNOT run cache program over the JAM logical drives), thus these data ARE COMPRESSED, and to make them visible for application programs JAM.SYS MUST EXPAND them. When you use JAM driver's own disk cache buffers (see discussion of /B switch above), this decompression overhead can be sometimes avoided. Example To install JAM driver that supports 1 logical drive with 8K clusters and uses 1 allocation and 1 data buffers, add to file CONFIG.SYS the following line: DEVICE=C:\JAM\JAM.SYS Error messages 1. JAM-driver already installed. Your CONFIG.SYS file has at least two lines that initialize JAM.SYS device driver. You may load the JAM driver only one time. To support more than one JAM drive use /M switch. 2. CPU Intel 80188/186+ or NEC V20/V30 required. JAM.SYS needs at least an Intel 80188/186+ or NEC V20/V30 CPU to work properly. If you have one of the more modern CPU (I80386, I80486, or Pentium), the JAM driver will automatically detect and fully utilize its power. 3. Incorrect DOS version. PC-DOS/MS-DOS 3.30-7.0, DR-DOS 6.0, or Novell DOS 7 required. See JCREATE error #1 (chapter 5.1.) for comments. 4. Insufficient memory. Insufficient memory is available to install the JAM driver. Try reduce number of its buffers (/A and /B parameters). You may also receive this message if you have tried to load JAM Driver high with some unsupported memory management software (currently, MS-,PC-,DR- and Novell-DOS EMM386.SYS drivers were tested, as well as QEMM, 386MAX, etc.). If the problem disappears when loading driver low, please contact us for update information. 5. Incorrect parameter. The specified switch is not supported by JAM.SYS or specified value is out of range. JAM 1.10 User's Guide Page 31 ------------------------------------------------------------------------ 4.3. The JMOUNT utility --------------------------- Shows JAM drive map, or mounts/unmounts JAM drives. Unlike other real-time compressors (e.g. SuperStor or Stacker) the JAM driver DOES NOT MOUNT ARCHIVE FILES AUTOMATICALLY. To perform a connection between each your JAM Archive Files and JAM drive letters you must run this utility. Thus you can set for each JAM drive its own ACCESS MODE (see section Notes for details). Syntax DEVICE=[drive1:][\][path1\]JMOUNT.COM [/M] [drive2:][\][path2\]filename[.jam] [drive3:] [/W[:][mode] | /R] DEVICE=[drive1:][\][path1\]JMOUNT.COM [/U] drive4: [/W[:][mode] | /R] DEVICE=[drive1:][\][path1\]JMOUNT.COM /D drive5: or JMOUNT [/M] [drive2:][\][path2\]filename[.jam] [drive3:] [/W[:][mode] | /R] JMOUNT [/U] drive4: [/W[:][mode] | /R] JMOUNT /D drive5: Parameters [drive1:][\][path1\] Specifies the location of the JMOUNT.COM file. [drive2:][\][path2\] Full or relative path of the file to mount. This is optional part of the file name. If you omit it, JMOUNT uses current DOS drive/ directory to find file to mount. filename[.ext] Specifies the name of the Archive file you want to mount. If you omit extension, JMOUNT uses ".JAM". drive3: Specifies the drive letter to assign to the newly mounted compressed drive. This switch is optional; if you don't specify a drive letter, JMOUNT assigns the new drive the next available drive letter. drive4: Specifies the drive for which you want to change the ACCESS MODE . drive5: Specifies the drive you want to unmount. JAM 1.10 User's Guide Page 32 ------------------------------------------------------------------------ Switches /M Establishes a connection between a JAM Archive File (filename[.jam] parameter) and a JAM drive letter (drive4: parameter), so that you can use the files the JAM file contains. This switch is optional; if you don't specify either /U, /W, /R or /D switches, JMOUNT performs this action, if 'filename' and 'drive4' parameters are found. /W[:][mode] Allows write/modify data on the newly mounted compressed drive. This switch is optional; if you don't specify /R switch, JMOUNT sets compressed drive to read-write mode with disabled direct write, enabled write-behind caching, and standard allocation strategy (see section NOTES for details). The following list describes each of the values you can use for mode. The colon (:) is optional. Use any combination of the values, and do not separate these values with spaces. +C or C enables write behind caching for the JAM-drive -C disables write-behind caching for the JAM-drive +U or U use fully undelete-compatible allocation strategy on the JAM drive -U use standard allocation strategy on the JAM drive +D or D enable direct write to the JAM drive -D disable direct write to the JAM drive /R Sets read-only mode for the newly mounted compressed drive. You cannot use this switch in combination with /W[:][mode]. /U Resets access mode for already mounted JAM drive 'drive4:'. This switch is optional; if you don't specify /M or /D commands and either /W, or /R switches are specified, JMOUNT performs this action. You may use this switch to make your JAM drive accessible or inaccessible for writing, to enable or disable write behind caching, or to change its allocation strategy (see section NOTES for details). /D Breaks the connection between the selected drive's compressed Archive File and its drive letter 'drive5:'. Unmounting a drive makes it temporarily unavailable. /Q Quiet mode (does not display status messages). JAM 1.10 User's Guide Page 33 ------------------------------------------------------------------------ Notes Current JAM drive map If you run JMOUNT with no parameters, it displays the current JAM drive map. For each drive letter that refers to the JAM drive, JMOUNT shows its Archive File and access mode (flags: [ReadOnly], [DirectWrite], [NoCache], [StdUndel]). In cases when the JAM drive is unmounted or is engaged by another JAM utility (for example if JMAX is working), JMOUNT displays status 'available' or 'locked' accordingly. Mounting JAM drives Read-Only By using /R switch, it is possible to protect all data on your JAM drive from any modifications. This mode will be useful for drives that contain executable files of some large packages, games, books and other information you need not to modify. Usually such data occupy about 80% and more of hard disk space and we recommend you to store and protect it using the JAM package. Control direct write requests Another level of data protection on the JAM drives is presented by the [DirectWrite] flag. This flag could be set/cleared by the /W[+|-]D switches' combination. When [DirectWrite] flag is cleared (the default setting), the JAM driver blocks all direct requests to write data. These requests (DOS interrupt #26h, and non-DOS JAM driver calls) could be produced only by some low-level disk utilities (e.g. Norton Utilities' DiskEdit, DiskTools, UnErase, etc.). So, if you want to run such an utility on the JAM drive, and COMPLETELY UNDERSTAND WHAT YOU HAVE TO DO, you should remount it to allow direct writing. After these activities are completed, run JMOUNT again to resume [DirectWrite] protection. Using write behind caching The /W[+|-]C combination of switches allows you to control the JAM internal cache system. By the default, the JAM driver uses write behind caching. This means that if JAM driver receives two or more requests to write data into the same group of adjacent sectors, and this area could be covered by JAM.SYS data buffers, then this area will be compressed and physically written only once. To make such optimization completely safe, the JAM driver keeps data in buffers only while DOS writes files, and flushes them when DOS finishes this work (i.e. when you close file). Nevertheless, having run JMOUNT utility with /W-C parameter you will force JAM.SYS write all data on disk immediately. This mode could be useful, for example, for system programmers, when they are debugging their programs, or doing everything else which may hang system in any moment. JAM 1.10 User's Guide Page 34 ------------------------------------------------------------------------ The JAM allocation strategies The JAM driver provides two alternative strategies of managing space in JAM Archive files. The first (default) strategy allows you efficiently use JAM Drive Physical Space, but has some limitations on possibility of successful file UnDelete operations. In other words, we can guarantee, that you will successfully UnDelete file only if you will run UnDelete utility IMMEDIATELY after the file was deleted. In other cases (if some data has been written to the JAM drive) even if your UnDelete utility reports that file is successfully recovered, you could find some corrupted clusters (containing garbage or zeros) in it. You will avoid this problem if you choose the second (Full Undelete Compatible) strategy. Working in this mode it is always possible to recover deleted files, if standard UnDelete utility tells that they are not damaged. But this method has one disadvantage -- excessive Physical Space usage. For example, immediately after deleting some of your files you will have slightly less amount of additional Physical Free Space than overall Physical Size of files deleted. To force JAM driver use all Available Physical Space in this mode, you should run JMAX utility with /C switch to clear (deallocate) all information in pending deleted files. Examples To mount the compressed Archive File TEST.JAM located on default drive/directory, as first available JAM drive (say, drive J:), you would type the following: JMOUNT /M TEST J: or just: JMOUNT TEST To make JAM drive J: read-only, you would type the following: JMOUNT /U /R J: or just: JMOUNT /R J: To unmount compressed drive J, type the following command: JMOUNT /D J: JAM 1.10 User's Guide Page 35 ------------------------------------------------------------------------ Error messages 1. Incorrect DOS version. PC-DOS/MS-DOS 3.30-7.0, DR-DOS 6.0, or Novell DOS 7 required. See JCREATE error #1 (section 4.1.) for comments. 2. JAM driver not installed. JMOUNT cannot perform any action, except show help screen (/? switch) while JAM driver isn't in memory. 3. Incorrect JAM.SYS version. You have incompatible versions of the JAM device driver (file JAM.SYS) and its mount/unmount utility (file JMOUNT.COM). You should either reinstall the latest release of the JAM package you have, or (if this error appears again) contact us to get the latest official release version. 4. Invalid parameter: xxxx. JMOUNT detects too many parameters. See section SYNTAX or run JMOUNT/? for help. 5. Invalid switch: xxxx. 6. Invalid combination of command line switches. Specified switch does not supported by JMOUNT or two of specified switches cannot be used simultaneously. See section SYNTAX or run JMOUNT/? for help. 7. No available JAM drive(s). All JAM drives are mounted. Dismount one of them, or increase number of JAM.SYS drives by specifying larger /M parameter in your CONFIG.SYS file. 8. JAM-drive specification expected. JMOUNT doesn't know to which JAM drive specified action (/D, or /U switches) refers. To reset, or unmount the JAM drive, you should specify its drive letter as an essential parameter. 9. Invalid drive specification: x: Specified drive does not exist, or it was spelled incorrectly. JAM 1.10 User's Guide Page 36 ------------------------------------------------------------------------ 10. Drive x: isn't a JAM device. 11. JAM drive x: already mounted. 12. JAM drive x: already unmounted. 13. JAM drive x: locked. Specified JAM drive is locked by another JAM utility (for example, by JMAX or JCHKDSK). You may receive this message if you run JMOUNT from a multitasking program other than MS-Windows, DESQview, MS-DOS Task Switcher, or DR-DOS TaskMAX. Check out the other sessions of your task manager, and wait while JMAX or JCHKDSK finishes its work. 14. JAM Archive File specification expected. Name of the JAM-file was omitted or spelled incorrectly. To mount the JAM drive, you should specify its Archive File as an essential parameter. 15. Invalid file name: xxxxxxxxx See JCREATE error #4 (section 4.1.) for comments. 16. JAM Archive File xxxxxxxxxxx already mounted as drive yy: You CANNOT mount a JAM Archive File as two or more JAM drives. To associate files on the JAM drive with different path /drive letter you could use DOS's ASSIGN, JOIN, or SUBST commands. See your DOS User's Guide for details. 17. Invalid drive in JAM Archive File specification: xxxxxxxxxxx See JCREATE error #4 (section 4.1.) for comments. 18. Cannot mount the Archive File located on a JAM device. 19. Cannot mount the Archive File located on a removable device. The current version (1.10) of the JAM driver cannot work properly with archive files located on diskettes or others removable medias. Support for removable drives will be added to the future versions of the JAM. Please contact us for update information. JAM 1.10 User's Guide Page 37 ------------------------------------------------------------------------ 20. Cannot mount the Archive File located on a non-DOS device. 21. Cannot mount the Archive File located on a remote device. The JAM driver cannot work with archive files located on a remote server. If you use one of the DOS-based LANs, you would have access to remote JAM files by installing the JAM on a server machine. 22. Incompatible sector size on drive x: JAM driver doesn't support devices with non-standard sector size (almost all hard-disks use 512-bytes sectors). You may receive this error if your JAM file located on a RAM-disk, which is driven, for example by PC-DOS VDISK.SYS or MS-DOS RAMDRIVE.SYS driver. In this case, you should reinstall your RAM-disk driver to have 512-bytes sectors (refer to your DOS User's Guide for details). 23. Cannot open JAM Archive File: xxxxxxxxxxx You may receive this message if specified file does not exist, its name was spelled incorrectly, or you have too many open files. To overcome the last case try to specify large value for the FILES= variable in your CONFIG.SYS file. 24. Cannot read initial sector(s) of xxxxxxxxxxxxx 25. Host drive error #xxxx. An error reading physical drive has occurred. To minimize the data loss the following steps should be taken: 1. Unmount all JAM drives which Archive Files are on a defective disk. 2. Run NDD, ScanDisk or other disk-repairing utility on your hard disk. 3. Reboot your computer. 4. Run JCHKDSK /F /T on your JAM drives. 26. File xxxxxxxxxxxx isn't a JAM Archive. Either specified file has never been a JAM Archive, or it is a seriously damaged JAM File. In the latter case, you should contact us for technical support. 27. Incompatible JAM Archive File version. Specified JAM Archive file is created by incompatible version of the JCREATE utility. Different versions of the JAM.SYS and JMOUNT.COM are required to properly work with this file. See also comments for JMOUNT error #3. JAM 1.10 User's Guide Page 38 ------------------------------------------------------------------------ 28. Invalid boot record in JAM Archive file: xxxxxxxxxxxx The JAM file xxxxxxxxxxxx has invalid boot record parameters. The file is probably corrupted or not a JAM file. Files that have been damaged in this way cannot be recovered automatically. See also comments for JMOUNT error #26. 29. JAM Archive file xxxxxxxxxx cluster size too large. The JAM file xxxxxxxxxx has larger cluster size than JAM.SYS driver is currently supported. Add /C=8 to the JAM.SYS line in CONFIG.SYS and reboot. 30. Bad first cluster, or file xxxxxxxxxxxxx is empty. JMOUNT cannot build list of sectors on your disk allocated by the JAM file xxxxxxxxxxxxxxx. Probably your hard disk file system is corrupted. Try to recover file xxxxxxxxxxxxxx manually (using DISKEDIT or others low-level disk-analyzing programs), and then do the steps described above for JMOUNT error #25. 31. Cannot read FAT on drive x: See JMOUNT error #25 for comments. 32. File xxxxxxxxxxx size/FAT chain mismatch. See JMOUNT error #30 for comments. 33. File xxxxxxxxxxx too fragmented. Defragment your Host Drive and then rerun JMOUNT. 34. Cannot mount file: xxxxxxxxxxxx in Undelete Compatible mode Some of your pending deleted files cannot be recovered. Having detected this, JMOUNT tries to mount archive file in standard mode. If you want to force the JAM driver work in Undelete Compatible mode again, you should do the following: 1. Run JMAX /C on a JAM drive on which file xxxxxxxxxxxx is mounted (to remove all pending deleted files on archive). 2. Run JMOUNT /U /W+U on this drive. (to set Undelete Compatible mode) JAM 1.10 User's Guide Page 39 ------------------------------------------------------------------------ 35. JAM Archive file xxxxxxxxxxx structure error - mounted read-only. A serious error in the JAM archive file structure was detected. To minimize the data loss, the following steps should be taken: 1. Run JCHKDSK /T on a JAM drive on which file xxxxxxxx is mounted. 2. Analyze the list of errors produced by JCHKDSK. a) Select all clusters which cannot be expanded. b) Select files which have these non-expandable clusters. c) Copy these files on any other drive, by DOS COPY command On all messages like: 'Unable to read data from drive x: (Abort,Ignore,Fail)?' answer 'I'- ignore. 3. Run JCHKDSK /T /F again. On all messages like: 'Cluster #yyyyy (file 'xxxxxxxxxx') cannot be expanded, Clear it [Y/N]? answer 'Y' - clear. 4. Run JMOUNT /U /W x: to switch a drive in read-write mode. 5. Replace all files which you have corrected by their copies. JAM 1.10 User's Guide Page 40 ------------------------------------------------------------------------ 4.4. The JDIR utility ------------------------- The purpose and usage of this program is very similar to the one of DOS's "DIR" command. The same as "DIR", JDIR displays a list of the files and subdirectories that are in the directory you specify. JDIR supports all standard switches of the MS-DOS 6.XX "DIR" and provides a lot of advanced features, e.g. displays files' attributes, displays files' fragmentation, detects allocation errors, etc. In addition, being run on the JAM drive, JDIR is able to calculate and show the compression percentage of files matched, and their average compression ratio. When you use JDIR without parameters or switches, it displays the disk's volume label and serial number; one directory or filename per line, including the filename extension, the file size in bytes, and the date and time the file was last modified; and the total number of files listed, their cumulative size, and the free space (in bytes) remaining on the disk. Syntax JDIR [drive:][\][path\][filename][.ext] [/P] [/W] [/A[:][attributes]] [/O[:][sortorder]] [/S] [/B] [/L] [/C[format]] [/F] [/K] [/M] [/T] [/U] [/Q] Parameters [drive:][\][path\] Specifies the drive and directory for which you want to see a listing. [filename][.ext] Specifies a particular file or group of files for which you want to see a listing. JAM 1.10 User's Guide Page 41 ------------------------------------------------------------------------ Switches /P Displays one screen of the listing at a time. To see the next screen, press any key. /W Displays the listing in wide format, with as many as five filenames or directory names on each line. /A[:][attributes] Displays only the names of those directories and files with the attributes you specify. If you omit this switch, JDIR displays the names of all files except hidden and system files. If you use this switch without specifying attributes, JDIR displays the names of all files, including hidden and system files. The following list describes each of the values you can use for attributes. The colon (:) is optional. Use any combination of these values, and do not separate the values with spaces. +H or H Hidden files -H Files that are not hidden +S or S System files -S Files other than system files +D or D Directories -D Files only (not directories) +A or A Files ready for archiving (backup) -A Files that have not changed since the last backup +R or R Read-only files -R Files that are not read-only JAM 1.10 User's Guide Page 42 ------------------------------------------------------------------------ /O[:][sortorder] Controls the order in which JDIR sorts and displays directory names and filenames. If you omit this switch, JDIR displays the names in the order in which they occur in the directory. If you use this switch without specifying sortorder, JDIR displays the names of the directories, sorted in alphabetic order, and then displays the names of files, sorted in alphabetic order. The colon (:) is optional. The following list describes each of the values you can use for sortorder. Use any combination of the values, and do not separate these values with spaces. +N or N In alphabetic order by name -N In reverse alphabetic order by name (Z through A) +E or E In alphabetic order by extension -E In reverse alphabetic order by extension (Z through A) +D or D By date and time, earliest first -D By date and time, latest first +S or S By size, smallest first -S By size, largest first +G or G With directories grouped before files -G With directories grouped after files +C or C By compression ratio, lowest first -C By compression ratio, highest first +F or F By file fragmentation, lowest first -F By file fragmentation, highest first JAM 1.10 User's Guide Page 43 ------------------------------------------------------------------------ /S Lists every occurrence, in the specified directory and all subdirectories, of the specified filename. /B Lists each directory name or filename, one per line (including the filename extension). This switch displays no heading information and no summary. The /B switch overrides the /W switch. /L Displays unsorted directory names and filenames in lowercase. This switch does not convert extended characters to lowercase. /C[format] Displays the compression ratio of files compressed using the JAM. If you use this switch without specifying format, JDIR displays the compression ratio as percentage of space saving. The following list describes each of the values you can use for format. D Default format (percentage of space saving) M MS-DOS 6.0 DIR format (xx.y to 1.0) S Stacker SDIR format (xx.y:1) The /C switch is ignored when used with the /W or /B switch. /F Displays file fragmentation. /K No volume label or pathname. /M Omit total bytes information. /T Displays file attributes. /U Displays summary information only. /Q Quiet mode (does not display status messages). JAM 1.10 User's Guide Page 44 ------------------------------------------------------------------------ Notes Using wildcards with JDIR You can use wildcards (* and ?) to display a listing of a subset of files and subdirectories. For an example illustrating the use of a wildcard, see the EXAMPLES section. Specifying file display attributes If you specify the /A switch with more than one value in attributes, JDIR displays the names of only those files with all the specified attributes. For example, if you specify the /A switch with the +R and -H values for attributes by using either /A:+R-H, /A:R-H, /A+R-H or /AR-H, JDIR displays only the names of read-only files that are not hidden. Specifying filename sorting If you specify more than one sortorder value, JDIR sorts the filenames by the first criterion first, then by the second criterion, and so on. For example, if you specify the /O switch with the E and -S values for sortorder by using either /O:+E-S, /O:E-S, /O+E-S or /OE-S, JDIR sorts the names of directories and files by extension, with the largest first, and displays the final result. The alphabetic sorting by extension causes filenames with no extensions to appear first, then directory names, then filenames with extensions. Using redirection symbols and pipes When you use a redirection symbol (>) to send JDIR output to a file or a pipe (|) to send JDIR output to another command, use the /A:-D, /B, and /Q switches to list only the filenames. You can use the filename parameter with the /B and /S switches to specify that JDIR is to search the current directory and its subdirectories for all filenames that match filename. JDIR lists only the drive letter, directory name, filename, and filename extension, one path per line, for each filename it finds. Before using a pipe for redirection, you should set the TEMP environment variable in your AUTOEXEC.BAT file. Otherwise, the temporary file will appear in the directory listing. JAM 1.10 User's Guide Page 45 ------------------------------------------------------------------------ Presetting JDIR parameters and switches You can preset JDIR parameters and switches by including the SET command with the DIRCMD environment variable in your AUTOEXEC.BAT file. You can use any valid combination of JDIR parameters and switches with the SET DIRCMD command, including the location and name of a file. For example, to use the DIRCMD environment variable to set the wide display format (/W) as the default format, include the following command in your AUTOEXEC.BAT file: SET DIRCMD=/W For a single use of the JDIR command, you can override a switch set by using the DIRCMD environment variable. To do so, you use the same switch on the JDIR command line, but you must also precede the switch letter with a minus sign, as the following example shows: JDIR /-W You can change the DIRCMD default settings by typing the SET command at the command prompt with a new parameter or switch after the equal sign (=). The new default settings are effective for all subsequent DIR commands until you use SET DIRCMD again on the command line or until you restart MS-DOS. Examples Suppose you want to display all files and directories in a directory, including hidden or system files. To specify this display, type the following command: JDIR /A Suppose you want JDIR to display one directory listing after another, until it has displayed the listing for every directory on the disk in the current drive. Suppose also that you want JDIR to alphabetize each directory listing, display it in wide format, and pause after each screen. To specify such a display, be sure the root directory is the current directory and then type the following command: JDIR /S/W/O/P JAM 1.10 User's Guide Page 46 ------------------------------------------------------------------------ JDIR lists the name of the root directory, the names of the subdirectories of the root directory, and the names of the files in the root directory (including extensions). Then JDIR lists the subdirectory names and filenames in each subdirectory in the directory tree. To alter the preceding example so that JDIR displays the filenames and extensions but omits the directory names, type the following command: JDIR /S/W/O/P/A:-D To print a directory listing, type the redirection symbol and PRN after any form of the DIR command, as the following example shows: JDIR > PRN When you specify PRN on the JDIR command line, the directory listing is sent to the printer attached to the LPT1 port. If your printer is attached to a different port, you must replace PRN with the name of the correct port. You can also redirect output of the JDIR command to a file by replacing PRN with a filename. A path is also accepted on the command line. For example, to direct JDIR output to the file JDIR.DOC in the RECORDS directory, type the following command: JDIR > \RECORDS\JDIR.DOC To display a list of all the filenames with the .TXT extension in all directories on drive C, type the following command: JDIR C:\*.TXT /W/O/S/P JDIR displays, in wide format, an alphabetized list of the matching filenames in each directory and pauses each time the screen fills, until you press a key to continue. JAM 1.10 User's Guide Page 47 ------------------------------------------------------------------------ Error messages 1. Invalid parameter: xxxxxx. Specified switch is not supported by JDIR utility. Run JDIR /? for help. 2. Invalid drive specification: xxxxxxxxx 3. Cannot resolve pathname: xxxxxxxxx Specified pathname cannot be resolved to fully qualified form (drive:\path\filename.ext). You may receive these messages if specified drive does not exist, or path\filename was spelled incorrectly. 4. Drive/pathname: xxxxxxxxxxxx redirected to: yyyyyyyyyyyyyy This message may appear if you run JDIR on a JOINed, SUBSTituted, ASSIGNed, or networked drives. In all such cases yyyyyyyyyyyyy means 'true' pathname that would be needed if the drive/path were not redirected as xxxxxxxxxxx. 5. Direct I/O not allowed for drive: x: Specified drive doesn't support direct access. You may receive this message on some networked or non-standard DOS drives. This error cannot appear on JAM drives. 6. Cannot read sectors #xxxx-yyyy on drive z: DOS error #ddd, BIOS error #bbb. An error occurred during direct reading drive z:. The following list describes each of the values you may receive as ddd and bbb. Device errors (ddd): 13h = attempted write on write-protected disk 14h = unknown unit ID 15h = disk drive not ready 16h = unknown command 17h = disk data error (CRC error) 18h = bad request structure length 19h = disk seek error 1ah = unknown disk media type 1bh = disk sector not found 1ch = printer out of paper 1dh = write fault error 1eh = read fault error 1fh = general failure JAM 1.10 User's Guide Page 48 ------------------------------------------------------------------------ BIOS errors (bbb): 80h = attachment failed to respond 40h = disk seek operation failed 08h = bad CRC on diskette read 04h = requested sector not found 03h = attempted write on write-protected diskette 02h = some error other than these listed above 7. Incorrect JAM.SYS version. You have incompatible versions of the JAM device driver (file JAM.SYS) and its directory display utility (file JDIR.COM). You should either reinstall the latest release of the JAM package you have, or (if this error appears again) contact us to get the latest official release. 8. Invalid boot record on drive x:. Either you run JDIR on a non-standard DOS drive, or this drive is seriously damaged. See also comments for JMOUNT error #28. 9. Not enough memory. Not enough memory to read disk structures (JDIR reads FAT, JDT (for JAM drives), and all directories in path and selecting tree (if /S switch specified)). On a PC with 640K of free DOS memory JDIR can handle disk with up to 4K subdirectories, containing up to 16K matching files. Try making more memory available to JDIR. If this does not rectify the problem then reduce the scope of your command and try again. 10. Too many matching files. See JDIR error #9 for comments. 11. Path x:\yyyyyyy not found. Specified directory does not exist. To show list of all directories on disk you may use: JDIR /A+D /B /S x:\ , where x: means your drive letter. JAM 1.10 User's Guide Page 49 ------------------------------------------------------------------------ 12. xxxxxxxx has allocation error !!! File xxxxxxxxx seriously damaged. Possible one of the following allocation errors: 1. File has invalid starting cluster number 2. One of entries in FAT chain is out of range 3. ........................... marked as bad cluster 4. ........................... makes a circular link 5. File size/ length of FAT chain mismatch Try to analyze your disk by JCHKDSK utility (without specifying /F switch). If no more serious errors will found, you could either recover this file manually (using for example DISKEDIT program), or (if it is impossible) delete this file. 13. File not found File(s) not matched in a directory, or specified directory is empty. To check the last case use *.* wildcards and /A: switch. JAM 1.10 User's Guide Page 50 ------------------------------------------------------------------------ 4.5. The JCHKDSK utility ---------------------------- This checks the status of a disk and displays a status report. Can also fix errors on standard DOS and JAM drives. The status report shows errors found in the DOS file system, which consists of the File Allocation Table (and JAM Descriptor Table for JAM drives) and Directories. If errors exist on the disk, JCHKDSK alerts you with a message. You should use JCHKDSK occasionally on each disk drive to check for errors. Syntax JCHKDSK [drive:][[\][path\]filename[.ext]] [/F] [/V] [/C] [/E] [/N] [/T] [/A] [/Q] [/X] Parameters drive: Specifies the letter of the drive you want JCHKDSK to check. This parameter is optional; if you do not specify a drive, JCHKDSK checks the current drive. [\][path\]filename[.ext] Specifies the location and name of a file or set of files that you want CHKDSK to check for fragmentation. You can use wildcards (* and ?) to specify multiple files. Switches /F Fixes errors on the disk. Do not use this option when running JCHKDSK from multitasking programs other than MS-Windows, DESQview, MS-DOS Task Switcher, or DR-DOS 6.0 TaskMAX. For more information, see "Using CHKDSK with open files" in section Notes below. /V Displays the name of each file in every directory as the disk is checked. /C Compares FAT copies. Use this switch on standard DOS drives to ensure that each copy of the File Allocation Table (FAT) are exactly the same. /E Shows empty files. This switch allows you to see all zero-length files on your disk. Some of such files could be left on your disk due to system hangs, crashes, etc. JAM 1.10 User's Guide Page 51 ------------------------------------------------------------------------ /N Strict file name checking. Assumes that file names may consist of: uppercased letters: A-Z, numbers 0-9, and some special characters: ~`!@#$%^&*()-_{}'. /T Tests readability and verifies the integrity of files on a JAM drive. /A Automatic mode. In combination with /F switch automatically selects the best way to recover most of disk errors. /Q Quiet mode (does not display status messages like 'Reading...', Comparing FATs..., etc.). /X Displays extended disk information (Sector and Cluster size, size of reserved disk area (Boot Sectors), size and number of FAT copies, maximum number of entries in the Root Directory, Total number of sectors on disk). Notes Format of status reports On a standard DOS drive JCHKDSK displays status report similar to the following example: Volume in drive C: has no label 10411008 bytes total disk space 57344 bytes in 2 hidden files 49152 bytes in 12 directories 6377472 bytes in 265 user files 3923968 bytes available on disk 4096 bytes in each allocation unit 2541 total allocation units on disk 958 available allocation units on disk 655360 bytes total memory 545984 bytes available memory JAM 1.10 User's Guide Page 52 ------------------------------------------------------------------------ To show extended disk information (Sector and Cluster size, size of reserved disk area (Boot Sectors), size and the number of FAT copies, etc.) you should run JCHKDSK with /X switch. Volume in drive C: has no label 512 bytes per sector 8 sectors per cluster 1 sector(s) reserved 2 FAT copies 8 sectors per FAT 512 maximum root directory entries 20383 total sectors on disk 10411008 bytes total disk space 57344 bytes in 2 hidden files 49152 bytes in 12 directories 6377472 bytes in 265 user files 3923968 bytes available on disk 4096 bytes in each allocation unit 2541 total allocation units on disk 958 available allocation units on disk 655360 bytes total memory 545984 bytes available memory On a JAM drive JCHKDSK displays more detailed report which includes both Logical and Physical JAM drive parameters, Average Compression Ratio, and Projected Free Space currently available. Volume in drive H: is TEST Volume Serial Number is 1B00-0F38 JAM logical drive H: JAM file: C:\TEST.JAM 25534464 bytes total disk space 10213376 bytes total archive space 57344 bytes in 2 hidden files 37376 bytes in 2 hidden files 98304 bytes in 12 directories 98304 bytes in 12 directories 7004160 bytes in 265 user files 4055552 bytes in 265 user files 18374656 bytes available on disk 6022144 bytes free on archive 58.82% average compression ratio (1.7:1) 13303808 bytes projected free space 655360 bytes total memory 545984 bytes available memory JAM 1.10 User's Guide Page 53 ------------------------------------------------------------------------ Fixing disk errors JCHKDSK will correct errors it finds if you specify the /F switch. If you do not use the /F switch, JCHKDSK alerts you with a message if a file needs to be fixed but does not fix the error(s). Detailed explana- tions and recommendations on fixing all disk errors which JCHKDSK can detect are given below in section Error Messages. Using JCHKDSK with open files Never use JCHKDSK when files are currently open. JCHKDSK is designed for use when the files on the disk are in an unchanging state -- that is, when they are not open. When a file is open, it is probably changing, and DOS will update the file allocation table and the directory structure to reflect changes. Such updates are not always made immediately, and updates to the file allocation table and the directories occur at different times. If you run JCHKDSK when files are open on the disk, it interprets differences between the directory structure and the file allocation tables as errors. Running JCHKDSK /F when files are open may result in corruption or loss of data. Therefore, never run JCHKDSK /F from another program, or when Windows, DESQview, MS-DOS Task Switcher or DR-DOS 6.0 TaskMAX (Novell DOS 7 Task Manager) are running. Using JCHKDSK with assigned drives and networks The JCHKDSK utility does not work on drives formed by the SUBST or ASSIGN commands. You cannot use JCHKDSK to check a disk on a network drive. Physical disk errors Being run on a standard DOS drive, the JCHKDSK could find only logical errors in the DOS file system, not physical disk errors. Nevertheless, being run on a JAM drive with /T switch, JCHKDSK could find also physical errors on a Host Drive. Bad disk sectors Bad sectors reported by JCHKDSK were marked as "bad" when your disk was first prepared for operation. Physical disk-error correction utilities can also mark sectors as "bad." Bad sectors pose no danger. ERRORLEVEL parameters If JCHKDSK does not find any errors, it returns an ERRORLEVEL value of 0. If JCHKDSK found one or more errors, it returns an ERRORLEVEL value of 255. Saving a JCHKDSK status report to a file You can save a JCHKDSK status report by redirecting the output to a file (located on any other disk drive, of course). Do not use the /F switch when you redirect JCHKDSK output to a file. JAM 1.10 User's Guide Page 54 ------------------------------------------------------------------------ Examples If you want to check the disk in drive A and have JCHKDSK fix any errors encountered, type the following command: JCHKDSK A: /F JCHKDSK pauses and displays messages if it encounters errors. Then it may prompt you to specify how you want JCHKDSK to correct the errors. JCHKDSK finishes by displaying a report showing the status of the disk. To redirect the output of JCHKDSK to a file named STATUS, type the following command: JCHKDSK A: > STATUS Because the output is redirected, JCHKDSK does not repair errors it encounters during the check; but it records all the errors in a report file. Afterward, you can use JCHKDSK with the /F switch without redirection to correct any errors noted in the status report. Error messages 1. Incorrect DOS version. PC-DOS/MS-DOS 3.30-7.0, DR-DOS 6.0, or Novell DOS 7 required. 2. CPU Intel 80188/186+ or NEC V20/V30 required. See JAM driver errors #2,3 (Section 4.2) for comments. 3. xxxxxxxxx has been detected. JCHKDSK cannot run in a multitasking environment. Please exit xxxxxxxxx and run JCHKDSK from the DOS command line. One of the following multitasking programs (xxxxxxxxxxxx) is running : OS/2 Windows 3.xx in Enchanced mode Windows 3.0 in Real or Standard mode DESQview MS-DOS Task Switcher DR-DOS 6.0 TaskMAX Novell DOS 7 Task Manager Please exit your task switcher and run JCHKDSK from the DOS command line. If you start JCHKDSK /F from some other multitasking programs, you may lose data. JAM 1.10 User's Guide Page 55 ------------------------------------------------------------------------ 4. Invalid parameter: xxxxxx. Specified parameter (or switch) is not supported by JCHKDSK utility. Run JCHKDSK /? for help. 5. Invalid drive specification x: Specified drive does not exist, or it was spelled incorrectly. 6. Probable non-DOS disk. The JCHKDSK utility cannot analyze non-DOS drives (which have non-DOS file organization). 7. Cannot check a network drive x: You cannot use JCHKDSK to check a disk on a network drive. 8. Cannot check a SUBSTed or ASSIGNed drive x: The JCHKDSK utility does not work on drives formed by the SUBST or ASSIGN command. To check files on drive x:, deactivate SUBST (or ASSIGN) and run JCHKDSK on drive that was assigned to x: instead. 9. There are open files on drive x: JCHKDSK has detected open files on drive x:. Please close all files on drive x: before running JCHKDSK. 10. JAM drive %c: already locked. See JMOUNT error #13 (Section 4.3) for comments. 11. Disk error #xxx: yyyyyyyyyyyyyyyyy An error occurred during direct reading from (writing to) the disk. The following list describes each of the values you may receive as xxx: 13h = attempted write on write-protected disk 14h = unknown unit ID 15h = disk drive not ready 16h = unknown command 17h = disk data error (CRC error) 18h = bad request structure length 19h = disk seek error 1ah = unknown disk media type 1bh = disk sector not found 1dh = write fault error 1eh = read fault error 1fh = general failure JAM 1.10 User's Guide Page 56 ------------------------------------------------------------------------ 12. Host drive hhh: error #xxx. An error reading (writing) physical drive has occurred. To minimize the data loss the following steps should be taken: 1. Unmount all JAM drives with Archive Files on a defective disk. 2. Run NDD, ScanDisk or other disk-repairing utility on your hard disk. 3. Reboot your computer. 4. Run JCHKDSK /F /T on your JAM drives. 13. Invalid disk parameters in boot record. Some logical characteristics of your disk found in Boot Sector appear to be incorrect. JCHKDSK cannot perform further testing. 14. Boot record / DOS DPB parameters mismatch. For no normal reason, disk parameters in Boot Record and in system memory are different. Try to reboot your computer and run JCHKDSK again. 15. Invalid signature in boot record. The drive is missing End of Boot Record signature (55AAh). Run JCHKDSK/F to fix this problem. 16. Media Descriptor Byte is invalid. The Media Descriptor Byte, located in the FAT, contains invalid information. The disk is either not a DOS disk or the Media Descriptor Byte has become corrupt. Use JCHKDSK with /F parameter to correct this value. 17. The FAT copies are not the same Each copy of the File Allocation Table (FAT) should be exactly the same. If an error occurs while DOS is updating the FATs, they may get out of synchronization with each other, resulting in data loss. To check (correct) this situation you could run JCHKDSK with /C switch. 18. Entry has a bad name 'xxxxxxxxxx' The directory has entry with invalid filename. JAM 1.10 User's Guide Page 57 ------------------------------------------------------------------------ 19. Entry has a duplicated name 'xxxxxxxxxx' The directory has entries in it which do NOT have unique filenames. You currently can access only the first entry in the directory which has the duplicated filename. To have access to second entry (file or directory) you should rename first one. 20. Entry 'xxxxxxxxxx' has a bad attribute The sub-directory has entry with volume LABEL attribute is set. Run JCHKDSK with /F switch to correct this problem. 21. Bad volume label 'xxxxxxxxxxx' Either the root directory has two or more entries marked as volume label, or entry xxxxxxxxxxx has non-zero length (or start cluster). Run JCHKDSK/F to convert this entry to file (or sub-directory). 22. Sub-directory 'xxxxxxxxxxx' has a bad size The sub-directory has invalid length. JCHKDSK /F is able to correct this value. 23. File 'xxxxxxxxxxx' is empty This warning may appear if you run JCHKDSK /E. Some of such files could be left on your disk since system hangs, crashes, etc. If /F switch also specified JCHKDSK prompts you to remove this file. 24. Entry 'xxxxxxxxxx' has invalid first cluster File or directory has an invalid link to the File Allocation Table. JCHKDSK /F could only remove such entry. Nevertheless, if the FAT still has a valid allocation chain, JCHKDSK will assign to it a name like LOST0001.CHK in the root directory. See also JCHKDSK error #46 for further details. 25. Entry 'xxxxxxxxxx', points into 'yyyyyyyyyyy' First cluster of entry xxxxxxxxxx points into disk area occupied by file yyyyyyyyyyyyyy. Use JCHKDSK /F to remove this entry. DO NOT use DOS's DEL command! 26. File 'xxxxxxxxxxx' has a bad link File or directory xxxxxxxxxxx has an invalid link in FAT chain. If you specify the /F parameter, JCHKDSK will truncate this file at the last valid cluster. JAM 1.10 User's Guide Page 58 ------------------------------------------------------------------------ 27. File 'xxxxxxxxxxx' has a circular link Circular link found in file xxxxxxxxxxx. Use JCHKDSK /F to break the loop in FAT chain. 28. Files 'xxxxxxxxxxx' and 'yyyyyyyyyyyy' are cross linked on allocation unit #zzzz. Files or directories are recorded as using the same disk space. JCHKDSK will not fix a cross-linked files, even if you specify the /F switch. To fix a cross-linked file, copy the specified files or directories elsewhere and delete the originals. Some of the information in these files may be lost. 29. File 'xxxxxxxxxx' has too long FAT chain. The amount of space occupied by the file xxxxxxxxxxx (length of FAT chain) is far more than its size (value described in directory entry). You could either truncate FAT chain, or continue checking assuming that FAT has true information. In the second case you will get the next message. 30. File 'xxxxxxxxxx' has invalid size. File size/ length of FAT chain mismatch. Use JCHKDSK /f to adjust file size to amount of space it is occupied on disk. 31. Invalid '.' and '..' entries Either directory is totally empty, or it does not contain '.' and '..' entries, or information stored in them is not correct. Run JCHKDSK /F to reconstruct these entries. In a subdirectory, the first two entries, (.) and (..), are not really files, but part of DOS's bookkeeping. They are pointers to where this subdirectory and its parent directory are on disk. The (.) file points to itself (its starting cluster is the same as the actual cluster location of the subdirectory "file" on the disk). The (..) file points to where it came from (its parent directory). 32. Cannot recover '.' and '..' entries There is no space in a directory to add '.' and '..' entries. Try to remove at least two files in this directory and run JCHKDSK /F again. JAM 1.10 User's Guide Page 59 ------------------------------------------------------------------------ 33. Cluster #xxx (in file 'yyyyyyyyyy') has invalid size 34. Cluster #xxx (in file 'yyyyyyyyyy') has invalid location 35. Cluster #xxx (in file 'yyyyyyyyyy') has invalid compression level 36. Cluster #xxx (in file 'yyyyyyyyyy') is cross linked on sectors #xxxx thru #yyyy in JAM archive Cluster has invalid parameters in JAM Descriptor Table. Use JCHKDSK /F to clear (physically deallocate) this cluster. If error #36 (physically cross-linked clusters) was detected, it is highly recommended to rerun JCHKDSK with /T switch to test clusters' readability. This will help you to select and clear only those clusters which actually are damaged (e.g. cannot be expanded). When the JAM driver detects any such an error itself (either during mounting an archive file, or during any file operation on a compressed drive) it returns to DOS the 'General Failure' error and switches this drive to read-only mode (to minimize the data corruption). So, whenever you find that your JAM drive is switched to read-only mode you should do the steps described for JMOUNT error #35. 37. Cluster #xxx (in file 'yyyyyyyyyy') has not been undeleted Cluster which is logically allocated (e.g. has non-zero FAT value), has a [Deleted] flag set to ON in JAM Descriptor Table (see Appendix B. for details). Use JCHKDSK /F to correct this flag (or, in case if cluster cannot be undeleted -- to clear this cluster). 38. Cluster #xxx (in file 'yyyyyyyyyy') has not been deleted Cluster which is logically deleted (e.g. has zero entry in FAT), has not a [Deleted] flag set to OFF in JAM Descriptor Table (e.g. occupies certain physical space). Run JCHKDSK /F to assign this cluster to file name like LOST0001 in the root directory (see also JCHKDSK error #46). 39. Cluster #xxx (in file 'yyyyyyyyyy') has been mistaken for directory Cluster which is logically belong to a file, has a [Directory] flag set to ON in JAM Descriptor Table (see Appendix B. for details). JAM 1.10 User's Guide Page 60 ------------------------------------------------------------------------ The JAM driver may set [Directory] flag to a non-subdirectory cluster only if: 1. Data stored in this cluster have very similar structure to one which have the DOS directories, and 2. This cluster (or whole file) was written on disk directly (e.g. not by standard DOS function). Use JCHKDSK /F to set this flag to off. 40. Cluster #xxx (directory 'yyyyyyyyyy') has not been taken for directory Cluster which is actually a sub-directory, has a [Directory] flag set to OFF in JAM Descriptor Table. The JAM driver cannot set [Directory] flag to a sub-directory cluster only if this cluster has a bad structure. Probably, some sectors in it were corrupted. If this is in case (JCHKDSK shows series of errors like #18-#25, or #31), you should: 1. Move all correct files from this directory on any other drive. 2. Run JCHKDSK /F to remove all invalid entries in this subdirectory. 3. Use DOS RD/MD commands to delete this subdirectory and create new with the same name. 4. Move all saved files back. If JCHKDSK will find no defect in this subdirectory, you should ensure that there is at least 16K bytes of physical free space and simply move one of files from this subdirectory to any other one, and then -- back to this directory: the JAM driver will correct the [Directory] flag itself. 41. Sub-directory 'xxxxxxxxxxxx' has not been allocated Cluster which is actually a sub-directory, has a [Allocated] flag set to OFF in JAM Descriptor Table (see Appendix B. for details). You may receive such situation, if you will try to create a subdirectory on a almost full JAM drive. Use DOS RD command or JCHKDSK/F to remove this subdirectory. If you want to create a correct subdirectory, you should be sure that there is at least 8K bytes of physical free space. JAM 1.10 User's Guide Page 61 ------------------------------------------------------------------------ 42. Sub-directory 'xxxxxxxxxxxx' has been compressed In normal conditions, the JAM driver does not compress subdirecto- ries. Moreover, if such subdirectory exists and you want to create or delete any file in it, the JAM driver will always try to expand and reallocate it before modifying its data. To force the JAM driver expand compressed subdirectory, you should free at least 16K bytes of physical space on the JAM drive and simply move one of files from this subdirectory to any other one, and then -- back to this directory. 44. Cluster #100 (file 'xxxxxxxxxx') cannot be expanded Compressed data integrity error. You could either try to recover some data, which this cluster contains, or clear it. To recover the data you should copy file 'xxxxxxxxxx' on any other drive, by DOS COPY command, and on all messages like: 'Unable to read data from drive x: (Abort,Ignore,Fail)?' answer 'I'- ignore. When this process finishes, you can examine this copy of the file to see if it contain any data you need. If /F switch specified, JCHKDSK will prompt you to clear this cluster. If you answer Y, JCHKDSK sets flag [Allocated] to OFF in JAM Descriptor Table. This flag will mean that this cluster consists of zeros (see Appendix B. for details). If you answer N, JCHKDSK keeps this cluster unchanged. 45. Sub-directory 'xxxxxxxxxxxx' cannot be expanded Compressed subdirectory integrity error. In this case directory tree past this point will not be processed, and therefore, all files which were stored in it will be recognized as LOST chains. See also JCHKDSK errors #40-44 and #46 for comments. 46. xxxxxx lost allocation unit(s) found in yyy chain(s). Convert lost chains to files? JCHKDSK found 'yyy' FAT chains which have not been assigned to directory entries, and therefore are inaccessible. JAM 1.10 User's Guide Page 62 ------------------------------------------------------------------------ If you answer Y, CHKDSK collects the lost clusters into files with the name LOSTnnnn.CHK (where nnnn is a number between 0000 and 9999) in the root directory. As long as these files are not in binary format you may be able to look at them using the EDIT or the TYPE command, recover any valuable data they contain, and then delete them. If you answer N, CHKDSK frees the lost clusters so that they can be used when new files are created. 47. There is no available entries in root directory. Overwrite deleted entries [Y/N] ? 48. Insufficient room in root directory. Move some files from root directory and repeat JCHKDSK. 49. Specified path not found. 50. Specified file(s) not found. Specified location or name(s) of file(s) for JCHKDSK fragmentation analysis was spelled incorrectly. JAM 1.10 User's Guide Page 63 ------------------------------------------------------------------------ 4.6. The JMAX utility --------------------------- Packs clusters compressed by the JAM driver tighter to give more available space on selected JAM drive. JMAX also automatically defragments and clears free space on the JAM drive. Syntax JMAX [drive:] [/M[:]method] [/C] Parameter drive: Specifies the drive you want to defragment. This parameter is optional; if you do not specify a drive, JMAX recompresses and defragments the current drive. Switches /M Specifies an optimization method to use. If you omit this switch, or specify /M without parameter, JMAX uses the highest compression method available (see list below). The following list describes each of the values you can use for the method. 0 - NO recompression (consolidate sectors only). 1 - FAST (the 1st level) recompression. Provides 20-30% better compression ratio than algorithm built-in the JAM driver. 2 - MAX (the 2nd level) recompression. This method allows you to get maximum compression ratio, but takes approximately twice more time than the 1-st method. /C Clears free space only. This switch is useful with JAM drives working in Full UnDelete Compatible mode (see Section 4.3. /Notes). JAM 1.10 User's Guide Page 64 ------------------------------------------------------------------------ Notes Difference between JMAX and standard Disk Defragmentation programs Standard Disk Defragmentation programs (e.g. Gazelle Systems' OPTune, Golden Bow's VOPT, Central Point Software's COMPRESS, Norton Utilities' SPEEDISK, etc.) optimize disk performance by reorganizing the files on a drive. You can use them to optimize uncompressed drives. Although you can run them on a JAM drive, doing so will probably not improve your system's speed. Unlike these programs, the JMAX utility does not perform file-level reorganization. JMAX recompresses and reorganizes compressed clusters to give you more free space on the JAM drive. Nevertheless, such optimization will also significantly speed-up the JAM drive (better compressed data require less space to store on physical disk, but also require less time to be expanded!). Examples To defragment drive D, you would type the following at the command prompt: JMAX d: To defragment the current drive, type the following command: JMAX Error messages 1. Invalid parameter: xxxxxx. Specified switch does not supported by JMAX utility. Run JMAX /? for help. 2. CPU Intel 80188/186+ or NEC V20/V30 required. 3. Incorrect DOS version. MS(PC)-DOS 3.30-7.XX, DR-DOS 6.0, or Novell DOS 7 required. See JAM driver errors #2,3 (Section 4.2) for comments. JAM 1.10 User's Guide Page 65 ------------------------------------------------------------------------ 4. OS/2 has been detected. 5. Windows 3.xx in Enchanced Mode has been detected. 6. Windows 3.0 in Real or Standard mode has been detected. 7. DESQview has been detected. 8. Task Switcher has been detected. 9. DR-DOS 6.0 TaskMAX has been detected. 10. Task Manager has been detected. JMAX cannot run in a multitasking environment. Please exit your task switcher and run JMAX from the DOS command line. If you start JMAX from some other multitasking programs, you may lose data. 11. JAM driver not installed. 12. Incorrect JAM driver version. 13. Drive x: isn't a JAM device. 14. JAM drive x: not mounted. 15. JAM drive x: locked. 16. Invalid boot record on JAM drive x: See JMOUNT errors #2,3,10,12,13,26 (Section 4.3.) for comments. 17. JAM drive x: mounted read-only. JMAX cannot optimize read-only mounted JAM drives. Run JMOUNT /U x: to enable write on drive x:. 18. Not enough memory. Not enough memory to read and analyze disk structures (JMAX tries to keep in memory FAT, JDT, and some additional tables. For example, to analyze the maximum possible JAM drive (512M bytes of logical space) JMAX needs approximately 512K bytes of conventional memory.). JAM 1.10 User's Guide Page 66 ------------------------------------------------------------------------ 19. Host drive error #xxxx. See JMOUNT error #23 (Section 4.3.) for comments. 20. Cannot read sectors #xxx-yyy in file zzzzzzzzzzzzzzz JAM.SYS error #eeee 21. Cannot write sectors #xxx-yyy in file zzzzzzzzzzzzzzz JAM.SYS error #eeee An error reading (writing) Host Drive is occurred. To minimize the data loss do the steps described for JMOUNT error #25. 22. Cluster #xxxx has not been deleted 23. Clusters #xxxx and #yyyy have the same FAT value 24. Cluster #xxxx has not been undeleted 25. Cluster #xxxx has invalid size 26. Cluster #xxxx has invalid location 27. Cluster #xxxx is a compressed subdirectory 28. Cluster #xxxx compressed by unknown method 29. Overlapped clusters #xxxx and #yyyy 30. Cluster #xxxx has incorrect FAT value 31. Data integrity error. Cluster #xxxx cannot be expanded. Allocation errors were detected on a JAM drive. Run JCHKDSK /F /T on drive x: first. See also JCHKDSK errors #33-45 for comments. 32. ... -> JMAX aborted Control-c or control-break was pressed. JAM 1.10 User's Guide Page 67 ------------------------------------------------------------------------ Chapter 5. Guidelines for efficient use of the JAM Drives =============================================================== This chapter highlights some of the techniques and considerations for efficient use of the JAM drives, allowing you to take full advantage of the JAM. 1. Refrain from storing access-time sensitive data on the JAM drives. Access-time sensitive data is defined as data to which access time is most critical, and to which access should be as fast as possible. Usually, a relatively large amount of access operations are performed on such data in a limited period of time. Data in this category are: * database index files: very high access rate; access time must be minimal. * program overlay (or dynamically linked libraries) files (those having a file extension of .OVL, .OVR, or .DLL), as well as programs which contain internal overlays (big .EXE files): they are accessed many times during the execution of an application. 2. Store data insensitive to access time on the JAM drives. This category includes word-processing documents and spreadsheet files. The access time for retrieving and saving such files is of lesser importance, and in most cases with the JAM an increase in access time is not even noticed -- while the benefit of data compression and space saving is optimal. 3. Store data with a high compression ratio on the JAM Although there is no restriction whatsoever on the nature of the data stored on the JAM drive, a basic understanding of the internal functions of the JAM will assist you in the proper selection of data suitable for storage. The data compression algorithms used by the JAM are based upon the Occurrence Rate of various characters (and strings of characters) in the data file. The effective Compression Ratio becomes larger as the number of similar characters, words and phrases in the file becomes greater. JAM 1.10 User's Guide Page 68 ------------------------------------------------------------------------ TEXT Files generally consist of a relatively small number of different characters (i.e. the printable characters, spaces, punctuation marks, etc.) with a relatively high occurrence rate. The vocabulary of them is also quite predictable based on the kind of text. Also, DATABASE and SPREADSHEET files typically contain many zeroes and spaces in a relatively high occurrence rate, as well as many similar words and numbers. These types of files have a high Compression Ratio potential. Many GRAPHICAL files are also well-suited to data compression. This includes CAD/CAM software, and many graphical storage formats used in image processing, desktop publishing, and multimedia industry (except for those already well-compressed file formats, for example, JPEG, GIF, some TIFF files). Therefore, when using a word-processor, database, or a spreadsheet program, maintain your document library, your database directory, or your spreadsheet directory on a JAM drive. On the other hand, in program files (i.e. those with a file extension of .EXE or .COM), most of the 256 possible characters (as well as 2-3 character combinations), may occur at a high rate. Therefore, these files are regarded as having a low Compression Ratio potential. There are exceptions: Windows programs usually contain resource data (bitmaps, icons, text strings, etc.) bind into .EXE files; such files also have high Compression Ratio potential. When in doubt, you may copy a file to the JAM drive, using the DOS COPY command. You may then use the JDIR utility to determine the exact Compression Ratio. If the compression is not satisfactory, you could try to recompress this drive (containing the copied file) by JMAX utility, and run JDIR again. If the compression still is not satisfactory, the copied file may be deleted from the JAM drive (or from the source drive if the Compression Ratio is satisfactory). 4. Use the JMAX utility. By using the JMAX utility, you can optimally recompress your data achieving even better kind of on-the-fly compression than ordinary JAM driver does. Often, you are not just saving disk space because of higher compression ratio - the access to JMAX-recompressed data becomes a bit faster! Also, the JMAX utility is quite smart - it would not do its job for a second time. So, you can recompress your JAM drive on weekly or even daily basis, not worrying about long time it takes to execute - if you have changed only one file on your JAM disk, JMAX would recompress only this file. See Chapter 4.6 for details on JMAX usage. JAM 1.10 User's Guide Page 69 ------------------------------------------------------------------------ 5. Use the DOS APPEND command. The DOS APPEND command enables you to distribute your data files on several disks and/or directories, yet access them in a completely transparent manner as if all of your files were in one large disk/ directory. In this way, you may store some of your data files on the JAM drive, your other files on a standard DOS disk, and use all of your files as if they all reside in your current disk or directory. Refer to your DOS manual for further information about the APPEND command. 6. Store seldomly used files on JAM drives. Many users today hold large volumes of data on-line, on their hard-disks, not willing to search for needed file on floppies or streamer cassette. This is fine, but some rarely-used on-line documentation or development toolkits can occupy quite a large portion of your hard disk, thus competing for disk space with your heavy-used data files. The one possible solution is to use file compression (archiving) programs, such as PKZIP, ARJ, etc. While these programs are extremely useful as good space-savers, they also do have one big disadvantage: you lose ability to work with your data transparently. Instead, you should instantly pack and unpack them. JAM offers a good compromise solution here: store such seldom-used files on a compressed JAM drive. You lose some bit of disk space comparing to file-archiving programs, but you would gain a transparent DOS access for these files! And on most 486-based machines, JAM drives can be read FASTER than DOS ones. This is because you properly utilize the horsepower of your CPU to help your disk drive. JAM 1.10 User's Guide Page 70 ------------------------------------------------------------------------ Chapter 6. F.A.Q. (Frequently Asked Questions) ==================================================== Q What does the name JAM mean? A JAM, n. very thick sweet liquid made from fruit boiled and preserved in sugar, used esp. for spreading on bread. jam, v. 1. to pack, crush, or gather, tightly into a small space. 2. To fill with people, cars, etc., so that movement is difficult or impossible. 3. ... Oops, just a short Longman quote. Well, it really means "JAM Archive Manager." Q In simple terms, how does the JAM work? A The JAM uses a certain portion (a large or small fraction, as determined by you) of the free space available on your hard disk drive. The JAM creates on your hard disk drive (Host Drive) a new DOS drive called the JAM drive. This acts exactly like a standard DOS drive (allowing you to continue using DOS and application programs, as usual) -- however, with one significant difference: the JAM compresses the data written to the JAM drive (automatically and in a completely transparent manner), thereby reducing the amount of disk storage required to store your data, on average, by 60% (2.5:1)! In other words, the JAM effectively enlarges the capacity of your hard disk. Q Can the JAM actually enlarge the capacity of my disk drive with its existing data and programs? A Yes! The JAM can provide you capability to effectively enlarge the capacity of your existing hard disk drive by saving, on the average 60% of the storage required by DOS to store your files. The JAM will not affect your existing data and programs. (Until you copy these files to a JAM drive and delete them from the Host drive, the disk space required to store these existing programs and data will not be reduced.) JAM 1.10 User's Guide Page 71 ------------------------------------------------------------------------ Q Do I have to do anything to my existing software applications or data files to use the JAM? A No. The JAM acts as a standard DOS drive and works in a completely transparent manner. Once it is loaded into memory (and this is done automatically when your computer is turned on), it does the work for you "in the background". As stated above, however, in order to reduce the storage capacity required for your existing data files they must be copied to a JAM drive. Q Will the JAM affect the performance of my existing software applications? A Yes, in some cases the JAM may affect the speed which your application software operates, however, it will not be noticeable to you, as it affects only the actual reading or writing of data to your hard disk. The overall effect is to a certain degree dependent upon the type of computer you are using (XT, 286 AT, or 386/486/Pentium AT). The slower the computer, the more noticeable any delay is; and your application software -- applications that are constantly updating data files -- may not be well suited for use with an JAM drive if you are using an XT (for example). Nevertheless, on modern i386/486 and Pentium computers the JAM drives usually work FASTER than original non-compressed DOS drives. Q Do I need to format my hard disk to use the JAM? A No. The JAM 1.10 creates the Compressed Drives as JAM Archives on your existing hard disk. The future versions will also compress whole hard disk partitions and floppy disks. Please contact us for upgrade information. Q Can I use the JAM drive as if it were a standard DOS disk? A Yes, you may use ANY DOS command, you may create directories on your JAM drive, backup, restore, etc. The JAM User's Guide provides a complete explanation regarding the usage of the JAM with DOS. JAM 1.10 User's Guide Page 72 ------------------------------------------------------------------------ Q Since the JAM is always in memory ready to work transparently for me, it is using a certain portion of my available main memory. How much it is using? A The JAM in its minimum configuration (i.e. only one JAM drive with 4K clusters, and minimum cache buffers) requires about 24Kb RAM resident memory. To support 8Kb cluster's drives JAM device driver requires 32Kb of memory. Each additional active JAM drive requires a small additional amount of RAM (about 1.2Kb RAM per logical drive). Moreover, you can load the JAM driver into upper memory (by EMM386 (from MS-DOS, DR-DOS, or Novell DOS), QEMM, 386MAX and other memory management software), thus, free some room in conventional memory used by DOS. Q Will the JAM work on any kind of hard disk drive? A Yes, the JAM should work on any type of hard disk with PC-DOS/MS-DOS 3.30 - 7.0, DR-DOS 6.0, or Novell DOS 7 in use. Q Will the JAM compress my RAM drive? A Yes. The JAM can enlarge the capacity of your virtual RAM disk, providing you with more room for frequently executing programs and temporary files. Q How does the JAM differ from other data compression utilities? A Unlike most data compression utilities, which compress data on a file-by-file basis (thereby keeping the data offline), the JAM compresses the data on a sector-by-sector basis, enabling the JAM driver to always retain your data online and available to you. Q How can I maximize my use of the JAM with my existing data and programs? A 1. Create a JAM drive. 2. Move your applications and data files to the JAM drive. 3. Run JMAX utility on this drive 4. For those program files (i.e. .EXE and .COM files) where the compression is less than satisfactory, you may move them back to the Host Drive. JAM 1.10 User's Guide Page 73 ------------------------------------------------------------------------ Appendix A. Glossary =============================== Physical Drives Physical disk drives are magnetic storage media of a predefined capacity and which range from several up to thousands megabytes. A Physical Drive is usually connected to a disk controller which constitutes a hardware link between the operating system and the physical storage media. Hard Disk Logical Drives Physical Drives may be divided into logical Partitions of a predeter- mined length using utilities such as the DOS FDISK, or various disk management programs. Each partition is assigned a Drive Name Letter corresponding to one Logical Drive. Host Drives Host Drive is the JAM terminology for a Logical Drive on which JAM Archive Files (see below) are created. Any Logical Drive (assigned to a Hard Disk partition) can act as a Host Drive. JAM Archive Files (or JAM Files) With the JAM, you may allocate space on your Host Drive to create the JAM Drive (see below). This space will be presented as a file (called JAM Archive File, or just JAM File) on your Host Drive. Being mounted as a JAM Drive, a JAM Archive will provide more storage capacity than the amount of space it uses. JAM Logical Drives (or JAM Drives) Being installed the JAM device driver provides one or more additional drives (called JAM Drives), which can represent compressed data in JAM Archives as standard DOS Logical Drives. JAM 1.10 User's Guide Page 74 ------------------------------------------------------------------------ Sectors and Clusters Information is recorded on a Logical Drive in units called sectors, whose size is determined by the FORMAT utility during the formatting process (the Sector length is usually equal to 512 bytes). Thereafter, this length remains constant unless the Logical Drive is reformatted. Furthermore, DOS groups the Sectors into Clusters, each of which consist of an equal number of Sectors. The Cluster Size (i.e. the number of sectors in a cluster) is also determined during the formatting process. While Sectors present a minimum chunk of information which can be read from or written to a disk, Clusters define the minimum File Allocation Unit. The disk is allocated one cluster at a time to files and directories. Cluster number always refers to the data area of a disk (space reserved for files and subdirectories). Valid cluster numbers always start at 2. They correspond to entries in the File Allocation Table (see below). On JAM drives clusters are INDEPENDENTLY COMPRESSED and allocated on Host Drive as smaller groups of adjacent sectors. To match where these groups are stored JAM uses additional table called JAM Descriptor Table (see below). The JAM driver supports clusters with logical size of 4K or 8K bytes (i.e. 8 or 16 sectors). Boot Record The first sector of a DOS Logical Drive always contains a data structure called the DOS Boot Record. This contains such critical information as Sector and Cluster Size, Reserved Sectors before FAT and Number of FAT Copies, Entries in Root Directory, Total Sectors on disk, etc., that is used by the system in accessing the media correctly. A standard DOS Boot Record contains a short program that is executed during system startup, which reads and executes the hidden system file, IO.SYS (or IBMBIO.SYS). If it can't locate this file, it typically displays a message similar to: Non-System disk or disk error. Replace and strike any key... The JAM Drives have some additional fields in Boot Record (refer to Appendix B. for details), and to prevent its destruction by some system transferring software (for example DOS's SYS.COM) the JAM driver protects this disk area from writing. JAM 1.10 User's Guide Page 75 ------------------------------------------------------------------------ DOS File Allocation Table (FAT) This is the part of DOS's bookkeeping system which maintains a record of where on the disk each File is stored. The technique is relatively simple. In the Directory Entry (see below) for each File is a Starting Cluster value. That cluster contains the first part of the file's data. If the file is more than one cluster, the FAT tells DOS where to find the next bit of the file's data. Each FAT cell identifies the next cluster occupied by the file's data. It's usually easy to follow a chain: for instance, FAT cell #2 contains a 3; #3 contains a 4, and so forth. The cell at the end of the chain contains an End Of File marker (0FFF or 0FFFF hex value). ______________________ +---------------------.| | Boot Sector || |=====================|| | FAT entries || ,----------------- #2: ,--[ 3 ]<--------. ------ | ,-------------- #3: `->[ 4 ]--. || | FAT chain | | ,----------- #4: [EOF]<-' || | ------ | | | ... | ............... || | | | | ,---- #MaxCls: [ 0 ] --- || | - unused cluster | | | ... | |=====================|| | | | | | | Root Directory || | | | | ... | | ............... || | | | | | | MYFILE.EXT [2]--------' - Starting cluster number | | | ... | | ............... || | | | | |=====================|| | | | ... | | Data Area || | | | | |---------------------||---------- `----------------->Cluster #2: || ^ | | | | ............... || Disk area where file `-------------->Cluster #3: || MYFILE.EXT is recorded. | | | ............... || Allocated space is: `----------->Cluster #4: || 3 * ClusterSize = 24K | | ............... || v (= 8K) StartSector = | |---------------------||---------- DataStart + | | ............... || ClusterNo * `---->Cluster #MaxCls: || ClusterSize; | ............... || +---------------------+ On JAM Drives File Allocation Table is an Incompressible object. Its location and number of its copies could be obtained from the JAM Drive Boot Record. JAM 1.10 User's Guide Page 76 ------------------------------------------------------------------------ JAM Descriptor Table (JDT) An additional table in the JAM Archive file which maintains allocation information for each compressed Cluster. The JAM device driver uses this data to determine where the cluster is stored and how many sectors it has in a compressed form. Each JDT cell has cluster's Flags ([Allocated], [Deleted], and [Directory] bits), Location in compressed Data Area (Starting Sector and the Number of Sectors values), and Compression method identifier. ______________________ +---------------------.| | Boot Sector || Starting Sector, |=====================|| Number of Sectors | JDT entries: || ,------------------- #2: [ 0 ][ 5 ]<-----------. ----- | ,---------------- #3: [ 6 ][ 7 ]<--------. | JDT entries used | | ,------------- #4: [ 14 ][ 3 ]<-----. | | ----- | | | | ................. || | | | | | | ,---->#MaxCls:[ empty ]- || | | | - unallocated | | | | |=====================|| | | | cluster | | | | | FAT entries || | | | | | | | | #2: ,--[ 3 ]<--------------+ ----- | | | | | #3: `->[ 4 ]--. --------' | FAT chain | | | | | #4: [EOF]<-' -----' | ----- | | | | | ............... || | | | | `---- #MaxCls: [ 0 ] --- || ------ | - unused cluster | | | |=====================|| | | | | | Root Directory || | | | | | ............... || | | | | | MYFILE.EXT [2]--------------' - Starting cluster | | | | ............... || number | | | |=====================|| | | | | Compressed Data Area|| | | | |---------------------||--------------- `------------------->Data Sector #0 || ^ | | ^ 5 + 1 | ............... || | | | v sectors| ............... || Archive area where file `---------------->Data Sector #6 || MYFILE.EXT is recorded. | ^ | ............... || Allocated space is: | | 7 + 1 | ............... || (5+1 + 7+1 + 3+1) | v sectors| ............... || * SectorSize = 9K `------------->Data Sector #14 || | ^ 3 + 1 | ............... || v v sectors|---------------------||--------------- | ............... || +---------------------+ JAM 1.10 User's Guide Page 77 ------------------------------------------------------------------------ The JAM Descriptor table is located between the Boot Sector and the first FAT on a JAM archive. This area is also visible on a JAM logical drive as an extension of the boot area. Like the Boot Record, JDT is accessible to DOS and standard application programs in read-only mode. Further detailed consideration, regarding the JAM internal structures is presented in Appendix B. Files The information in a Logical Drive is stored in units called Files. From user's point of view, a file contains a specific set of data, such as a document, spreadsheet, data base, program, etc. DOS stores the files on your Logical Drives using an integral number of Clusters. A File always starts at the Beginning of a new Cluster, and occupies as many Whole Clusters as required to contain the entire file, even if this means that the last Cluster remains almost completely empty (and therefore, wasted). Such wasted space is called Slack space, and it is typical that 10% to 30% of your hard disk is Slack space. On JAM Drives all Clusters of the File are independently compressed, and allocated as a portions of adjacent Sectors. Such technique allows you almost completely eliminate the Slack space, thereby providing a major ancillary benefit. Directories These are the disk data areas that hold the bookkeeping information about disk files. All DOS Logical Drives have at least one Directory, the Root Directory, which is stored at an easy-to-find place at the start the drive. For each File, DOS maintains a Directory Entry. It contains the File's Name, Size, the Date and Time when it was created or last modified, File Attribute information, and the disk address where the first part of the file data is stored. Besides standard File Entries, a Directory might contain two other types of entries. First, the Root Directory may contain a Volume Label. (It is displayed when you type DIR or JDIR from the DOS prompt, but serves merely as an identifier.) The other type of entry is a Subdirectory Entry. These are critical to the operation of DOS. Instead of describing the size and location of a file, each points to another directory. JAM 1.10 User's Guide Page 78 ------------------------------------------------------------------------ In all but the Root Directory, there are two special Subdirectory Entries, with the Filenames of "." and ".." (dot and dot-dot, as they're called, or sometimes, "self" and "parent"). The "." entry points to cluster containing this directory, while ".." entry points back to the directory in which it is described. This system helps DOS climb around the directory tree. On JAM drives both root-directory and subdirectories are not compressed. This solution provides high speed of directory access and make usage of compressed devices more reliable. JAM 1.10 User's Guide Page 79 ------------------------------------------------------------------------ Appendix B. JAM technical information ============================================= B.1. JAM Drive Structure On logical level the JAM devices have absolutely the same structure as standard DOS disks. At the very beginning (sector # 0) they contain standard Boot Record; next sectors represents one or two copies of DOS File Allocation Table (FAT); then there are 4, 8, or 16 sectors of Root Directory, and finally -- clusters of files and subdirectories on logical disk. N Disk area Size (in sectors) --- -------------------- ---------------------------- 1. Boot Sector(s) ReservedSectors 2. FAT#1 ... FAT#N FatSize * FatCount 3. Root Directory (RootEntries * 32) /SectorSize 4. Data Clusters. MaxCluster * ClusterSize But, such a standard disk layout is just a result of following DOS disk structure conventions. Our main concern is about how the compressed data is actually stored on disk. The disk space is allocated by DOS in a units of clusters. To ensure maximum speed and reliability, JAM driver compresses each cluster independently. The size of compressed cluster can be different, depending on the compression ratio and the amount of data actually contained in the cluster (remember that file with size of 1 byte occupies 1 cluster in DOS!). To achieve actual space savings, JAM stores each compressed cluster in a number of (continuous) physical disk sectors. So, to read a portion of a file by its cluster number (given by DOS), JAM driver should find where on the disk the compressed cluster is located, and what is its size. To store such information, JAM needs a separate table for it. This table is called the JAM Descriptor Table (JDT). For each cluster (either allocated or free), this table contains the cluster's compressed size (in sectors), starting location (as a sector number), compression method used, and some status flags. This table is stored just before first FAT, inside boot sectors. (Normal DOS disks contain only 1 sector in Boot Sectors area. Therefore, this sector is often called just a Boot Sector. The JAM uses this area to store a Boot Sector, followed by JDT entries.) JAM 1.10 User's Guide Page 80 ------------------------------------------------------------------------ JAM Archive File structure: N Area Size (in sectors) --- -------------------- ---------------------------- 1. Boot Sector 1 + 2. JAM Descriptor Table (MaxCluster * 4) /SectorSize ------------------------------ ReservedSectors 3. FAT#1 ... FAT#N FatSize * FatCount 4. Root Directory (RootEntries * 32) /SectorSize 5. Compressed Data Area. MaxCluster * ClusterSize /ExpectedCompRatio = CompDataSectors The format of the JAM Drive Boot Sector (which is an extension over standard DOS 4.0+ Boot Sector format) and JAM Descriptor Table is given below. Format of the JAM boot sector Offset Size Description 00h 3 BYTEs near jump to start of boot code 03h 8 BYTEs *OEM company name and version ('JAM x.yy', x.yy - version) 0Bh 25 BYTEs extended BIOS parameter block (BPB) 24h BYTE physical driver number (0 = floppy, 80 = hard disk) 25h BYTE reserved 26h BYTE extended boot record signature 27h DWORD volume serial number 2Bh 11 BYTEs volume label 36h 8 BYTEs file system ID 3Eh DWORD *compressed data area size (in sectors) 42h 2 BYTEs *reserved 44h DWORD *original total number of sectors on drive \ before archive 48h DWORD *original compressed data area size / was shrinked 4Ch 64 BYTEs *encrypted password 8Ch 370 BYTEs boot code 1FEh WORD end of boot sector signature (55AAh) JAM 1.10 User's Guide Page 81 ------------------------------------------------------------------------ Format of the JAM cluster descriptors (4-bytes cells of the JAM Descriptor Table) Offset Size Description 00h BYTE cluster size (in sectors) bits 0..3: cluster size - 1 flags (cluster type) bit 4: reserved (always sets to 0) bit 5: Directory bit 6: Deleted bit 7: Allocated 01h BYTE starting sector number (high 4 bits) bits 0..3: (starting sector >> 16) & 0Fh compression level bits 4..6: 0 - real-time compression (built-in driver algorithm) 1 - normal compression 2 - maximum compression (built-in JMAX algorithms) 3..7 - reserved compression flag bit 7: (0 - cluster stored/1 - compressed) 02h WORD starting sector number (low word) It should be noted that besides of cluster allocation information (cluster size and starting sector number), descriptor also has several flags which are used by the JAM driver to determine the type and current status of the cluster. When flag [Allocated] is set to 0, the cluster is considered EMPTY (i.e. containing zeros), and the other parameters in descriptor are ignored. All clusters which have been written to the JAM drive (and therefore use some physical space in JAM archive), must have [Allocated] flag set. The flag [Deleted] is used to indicate that cluster was deleted. When DOS removes cluster (i.e. sets corresponding entry in FAT to 0), the JAM driver sets [Deleted] flag to 1. Then if you run some UnDelete utility (e.g. Central Point Software's Undelete, or Norton Utilities' Unerase), JAM.SYS analyzes the integrity of data in this cluster, and if they have not been overwritten, JAM driver sets the [Deleted] back to 0, thus, making it possible to undelete files on JAM drives. JAM 1.10 User's Guide Page 82 ------------------------------------------------------------------------ The [Directory] flag means that cluster contains subdirectory information. To make access to subdirectories more reliable and fast, the JAM driver does not compress such clusters. Moreover, if (under no normal reasons) compressed subdirectory exists, JAM.SYS will always expand it automatically. Finally, JAM descriptor contains information on the compression method used to pack the cluster. Actually, the JAM system incorporates several compression algorithms, which differ by compression ratio/speed tradeoff. The JAM driver includes the fastest (real-time) algorithm, which internal number is 0. Two other methods (slower, but better on compression ratio) are built in JMAX utility (its numbers are 1 and 2 respectively). The numbers 3..7 are reserved for future algorithms. JAM 1.10 User's Guide Page 83 ------------------------------------------------------------------------ B.2. JAM device driver In order to better understand how the JAM works, let us review how DOS operates with your application software to read and write data on your hard disk. General Data Flow Control under DOS can best be illustrated as: ,----------------------------. | Application Programs | `-------------/\-------------' (1) :: ,-------------------\/-------------------. | DOS Kernel | `-------------------/\-------------------' (2) :: ,-----------------------\/-----------------------. | Disk Device Driver | `-----------------------/\-----------------------' (3) :: ,-------------\/-------------. | Disk BIOS (Int 13h) | `-------------/\-------------' (4) :: ,-------\/-------. | Hard Disk | `----------------' where: Application - is your software program; DOS Kernel - is a main part of the Disk Operating System; Disk Device Driver - is the system control program assigned by DOS to interface to your hard disk device. The reading of data from your hard disk consist of four steps: 1. Application <--> DOS Kernel Read data from hard disk C: 2. DOS Kernel <--> Device Driver for drive C: Read nn sectors starting at sector xxxx from logical drive #2 3. C:'s Device Driver <--> Disk BIOS Read nn sectors starting at <head hhh, track ttt, sector sss> from a hard disk 4. Disk BIOS <--> Hard disk Perform series of hardware-depended operations to read information recorded on a hard disk. JAM 1.10 User's Guide Page 84 ------------------------------------------------------------------------ The writing of data to your disk also consists of four steps: 1. Application <--> DOS Kernel Write data to hard disk C: 2. DOS Kernel <--> Device Driver for drive C: Write nn sectors starting at sector xxxx to logical drive #2 3. C:'s Device Driver <--> Disk BIOS Write nn sectors starting at <head hhh, track ttt, sector sss> to a hard disk 4. Disk BIOS <--> Hard disk Perform series of hardware-depended operations to record information on a hard disk. The JAM reorganizes requests to the Hard Disk Device Driver, and acts as the Device Driver for the JAM logical drive. In addition, the JAM compresses (during write) and decompresses (during read) the data written to or read from the JAM drive. Data Flow Control when using the JAM can be (with some simplifications) illustrated as: ,------------------------------------------. ,,===================.. | User's Application Programs | || JAM Utilities || `--/\-----------------/\---------------/\--' ``=/\================'' (1) :: (7) :: (9) :: (11) :: ,,=====\/======.. ,,=====\/======.. ,,===\/========\/=.. ,,=============.. || JAM Int 21h || || JAM Int 24h || || JAM Int 2Fh || || JAM Int 2Ah || ``===/\===/\==='' ``===/\===/\==='' ``===/\======/\==='' ``===/\===/\==='' (2) :: || (8) :: || (10) :: || (12) :: || ,----\/-----------------\/-----------------\/--------------------\/---------. | DOS Kernel | `-------------------------------------/\------------------------------------' (3) || || :: || || ,,=======\/=================\/=======\/===========\/=================\/==.. || JAM Driver || ``===================================/\=================================='' (4) :: ,------------------------\/-----------------------. | Host Disk Driver | `------------------------/\-----------------------' (5) :: ,-------------\/-------------. | BIOS (Int 13h) | `-------------/\-------------' (6) :: ,-------\/-------. | Hard Disk | `----------------' JAM 1.10 User's Guide Page 85 ------------------------------------------------------------------------ where: JAM Int 21h/24h/2Ah/2Fh - are the JAM.SYS interrupt handlers JAM Driver - is a main part of the JAM.SYS program, which simulates JAM Logical Drives JAM Utilities - the others programs used the JAM API interface (see the next section for details) The reading of data from your JAM drive consist of six steps: 1. Application <--> JAM Int 21h Read data from the JAM drive J:. JAM Int 21h tracer simply passes request to the DOS kernel (and forwards the DOS error code back to Application). 2. JAM Int 21h <--> DOS Kernel Read data from the JAM drive J:. 3. DOS Kernel <--> J:'s JAM Driver Read nn sectors starting at sector xxxx from JAM logical drive. JAM driver analyses JDT to find location of the compressed data on JAM archive, calls the Host Disk driver to read them, decompresses them and passes back to DOS Kernel for application program. 4. J:'s JAM Driver <--> Host Disk (C:)'s Device Driver Read nn sectors starting at sector xxxx from hard disk logical drive #2 5. Host Disk (C:)'s Device Driver <--> Disk BIOS Read nn sectors starting at <head hhh, track ttt, sector sss> from a hard disk 6. Disk BIOS <--> Hard disk Perform series of hardware-depended operations to read information recorded on a hard disk. The writing of data to your JAM drive also consists of six (main) steps: 1. Application <--> JAM Int 21h Write data to the JAM drive J:. JAM Int 21h tracer passes request to the DOS kernel. When DOS finishes this operation, JAM Int 21h tracer analyzes state of the JAM drive, and if it is needed (for example, when archive file is almost full) -- calls DOS and JAM driver again to flush its buffers (to perform file system synchronization). Finally, JAM Int 21h tracer forwards the DOS error code back to Application. 2. JAM Int 21h <--> DOS Kernel Write data on the JAM drive J:. JAM 1.10 User's Guide Page 86 ------------------------------------------------------------------------ 3. DOS Kernel <--> J:'s JAM Driver Write nn sectors starting at sector xxxx on JAM logical drive. JAM driver splits requested sectors area [xxxx..xxxx+nn] on series of logical clusters [yy..yy+m] which cover this region. For each cluster, JAM.SYS gets corresponding JDT entry to determine if the cluster was already written (allocated) on disk, and its allocation parameters. In case if cluster was already allocated and JAM.SYS should modify only part of it, the clusters data will be read, then expanded (if it was stored in a compressed form), updated, compressed again, and finally -- physically written on archive. If the cluster is empty, or JAM.SYS should modify all its sectors, the cluster's data will be simply compressed and written on archive. To write data on archive (or to read them from), the JAM driver calls the Host Disk driver. 4. J:'s JAM Driver <--> Host Disk (C:)'s Device Driver Write nn sectors starting at sector xxxx to hard disk logical drive #2 5. C:'s Device Driver <--> Disk BIOS Write nn sectors starting at <head hhh, track ttt, sector sss> to a hard disk 6. Disk BIOS <--> Hard disk Perform series of hardware-depended operations to record information on a hard disk. Some additional steps will be taken when current write request cannot be successfully performed. For example, JAM Int 24h tracer may be activated (steps 7 and 8) to handle an Archive Overflow exception accurately (there is no corresponding device error code in DOS, except for MS-DOS 6.0+). The JAM Int 2Ah/2Fh (and several others) tracers are used to solve some compatibility problems (for example, to tell SMARTdrive cache utility that JAM drives are non-cacheable), and to represent an interface to the other JAM utility programs (see the next section for details). JAM 1.10 User's Guide Page 87 ------------------------------------------------------------------------ B.3. JAM Application Interface The following functions can be used by application programs to work with the JAM drives. Current version (1.10) of JAM.SYS supports 8 functions, accessed as INT 2Fh/AX=5200...5207h. Functions AX=5208..521F are reserved for future versions of the JAM. --------d-2F5200----------------------------- INT 2F - JAM.SYS 1.10 - "GetVersion" - INSTALLATION CHECK AH = 52h AL = 00h Return: AH = 80h (successful) BX = internal JAM.SYS version number CX = size of JAMINFO structure (see below) DX = JAM.SYS segment address Program: JAM.SYS is a main component of the JAM Real-Time Data Compression Utilities by George A. Reznik and friends (JAM Software). SeeAlso: AX=5201h Format of JAMINFO structure: Offset Size Description 00h 25 BYTEs extended BIOS parameter block (BPB) 25h DWORD total number of sectors in JAM archive file (size of compressed data area) 29h BYTE flags bit 7: full undelete-compatible allocation strategy bit 6: no write-behind caching bit 5: read-only mode bit 4: enable direct write requests (Int 26h, non-DOS requests, etc.) bits 3..0 are reserved for internal use 2Ah 127 BYTEs full JAM archive file name A9h WORD the number of fragments in archive file ABh 96 BYTEs archive file fragmentation list - array of 16 FRAGMENT structures: Offset Size Description 00h WORD starting sector (low word) 02h BYTE starting sector (high byte) 03h WORD size of fragment (low word) 05h BYTE size of fragment (high byte) 10Bh DWORD address of the host-drive DPB (Drive Parameter Block) 10Fh DWORD number of free sectors in JAM archive file 113h WORD device status word (see below) JAM 1.10 User's Guide Page 88 ------------------------------------------------------------------------ Values for status (high byte, low is DOS error code for Host drive): 00h successful 01h drive is not a JAM drive 02h drive is already attached 03h archive file cluster size value is larger than driver's one 04h drive is not attached 05h drive is locked 06h drive is not locked 07h bad physical-level request 08h host drive reading/writing error 09h bad entries in JAM descriptor table 0ah compressed data integrity error 0bh archive file overflow 0ch bad DOS request 0dh incorrect parameters in JAMINFO structure --------d-2F5201----------------------------- INT 2F - JAM.SYS 1.10 - "GetInfo" - GET COMPRESSED DRIVE INFORMATION AH = 52h AL = 01h DL = compressed drive number (0-default, 1-A:, etc.) DS:BX -> buffer for JAMINFO structure (see above) Return: AH = status (see also above) 00h successful 01h drive is not a JAM drive SeeAlso: AX=5200h --------d-2F5202----------------------------- INT 2F - JAM.SYS - "Attach" - MOUNT COMPRESSED DRIVE AH = 52h AL = 02h DL = drive number (0-default, 1-A:, etc.) to attach to the JAM archive file DS:BX -> pointer to JAMINFO structure (see above), which contains parameters of the JAM file to mount, and pointer to the host drive DPB (i.e. DPB of the drive on which the JAM file is located) Return: AH = status (see also full list above) 00h successful 02h drive already attached 03h archive file cluster size value is larger than driver's one - not mounted 08h host drive reading error (while building allocation list) 09h bad entries in JAM descriptor table - file mounted read-only 0dh incorrect parameters in JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5203h JAM 1.10 User's Guide Page 89 ------------------------------------------------------------------------ --------d-2F5203----------------------------- INT 2F - JAM.SYS 1.10 - "Detach" - UNMOUNT COMPRESSED DRIVE AH = 52h AL = 03h DL = drive number (0-default, 1-A:, etc.) to detach Return: AH = status (see also full list above) 00h successful 01h drive is not a JAM drive 04h drive already detached 05h drive locked 08h host drive reading/writing error (while flushing buffers) 09h bad entries in JAM descriptor table 0bh archive file overflow 0dh incorrect parameters in drive's JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5202h --------d-2F5204----------------------------- INT 2F - JAM.SYS 1.10 - "Lock" - LOCK COMPRESSED DRIVE AH = 52h AL = 04h DL = drive number (0-default, 1-A:, etc.) to lock Return: AH = status (see also full list above) 00h successful 01h drive is not a JAM drive 04h drive is not attached 05h drive already locked 08h host drive reading/writing error (while flushing buffers) 09h bad entries in JAM descriptor table 0bh archive file overflow 0dh incorrect parameters in drive's JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5205h, AX=5206h, AX=5207h --------d-2F5205----------------------------- INT 2F - JAM.SYS 1.10 - "UnLock" - UNLOCK COMPRESSED DRIVE AH = 52h AL = 05h DL = drive number (0-default, 1-A:, etc.) to unlock Return: AH = status (see also full list above) 00h successful 01h drive is not a JAM drive 04h drive is not attached 06h drive is not locked 08h host drive reading error (while rebuilding allocation list) 09h bad entries in JAM descriptor table 0dh incorrect parameters in drive's JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5204h, AX=5206h, AX=5207h JAM 1.10 User's Guide Page 90 ------------------------------------------------------------------------ Note: Lock and UnLock functions were added to the JAM API to prevent asynchronous physical-level access (see AL=06/07) to compressed data on JAM drives. In other words, two or more programs which use JAM API (say, JMAX optimizer and JCHKDSK - disk checker) cannot be run on the same JAM drive simultaneously. --------d-2F5206----------------------------- INT 2F - JAM.SYS 1.10 - "Read" - PHYSICAL READ DATA FROM JAM ARCHIVE AH = 52h AL = 06h DL = drive number (0-default, 1-A:, etc.) DS:BX -> disk transfer packet (see below) Return: AH = status (see also full list above) 00h successful 01h drive is not a JAM drive 04h drive is not attached 06h drive is not locked 07h bad request (parameters in transfer packet) 08h host drive reading error 0dh incorrect parameters in drive's JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5207h Format of disk transfer packet: Offset Size Description 00h DWORD sector number 04h WORD number of sectors to read(write) 06h DWORD transfer address --------d-2F5207----------------------------- INT 2F - JAM.SYS 1.10 - "Write" - PHYSICAL WRITE DATA TO JAM ARCHIVE AH = 52h AL = 07h DL = drive number (0-default, 1-A:, etc.) DS:BX -> disk transfer packet (see above) Return: AH = status (see also above) 00h successful 01h drive is not a JAM drive 04h drive is not attached 06h drive is not locked 07h bad request (parameters in transfer packet) 08h host drive writing error 0dh incorrect parameters in drive's JAMINFO structure AL = host drive error code (see DOS device error codes) SeeAlso: AX=5206h --------------------------------------------- JAM 1.10 User's Guide Page 91 ------------------------------------------------------------------------ I n d e x ============= +---+ | A | +---+ AUTOEXEC.BAT . . . . . . . . . . . . . . . . . . 12, 28, 28, 44, 45 Access-time Insensitive Data . . . . . . . . . . . . . . . . . . 67 Sensitive Data . . . . . . . . . . . . . . . . . . . . . . . 67 Actual Capacity . . . . . . . . . . . . . . . . . . . . . . . . . 10 Allocation Buffers . . . . . . . . . . . . . . . . . . . . . 27, 28 Errors . . . . . . . . . . . . . . . . . 49, 53, 57, 58, 59, 66 Strategies . . . . . . . . . . . . . . . . . . . . . . . . . 34 Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 File . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 13 Average Compression Ratio . . . . . . . . . . . . . . . . . . . . 52 +---+ | B | +---+ BIOS Device error codes . . . . . . . . . . . . . . . . . . . . . 48 Bad Sectors . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Basic Concepts of the JAM . . . . . . . . . . . . . . . . . . . . 9 Boot Record . . . . . . . . . . . . . . . . . . . . . . . 56, 74, 80 Sector . . . . . . . . . . . . . . . . . . . . . . . . . 74, 80 Buffers for Allocation information . . . . . . . . . . . . . 27, 28 Compressed Clusters . . . . . . . . . . . . . . . . . 27, 28 +---+ | C | +---+ CONFIG.SYS . . . . . . . . . . . . . . . . . . . 14, 24, 27, 28, 28 CPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 80188/186+ . . . . . . . . . . . . . . . . . . . . . . . . . 30 I80386/I80486/Pentium . . . . . . . . . . . . . . . . . . . . 30 NEC V20/V30 . . . . . . . . . . . . . . . . . . . . . . . . . 30 Cache Built-in JAM driver . . . . . . . . . . . . . . . . . . . . 28 Capacity Logical . . . . . . . . . . . . . . . . . . . . . . . . 9 Physical . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Projected . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Cluster . . . . . . . . . . . . . . . . . . . . . . . 17, 22, 23, 74 Size . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 27 Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Methods . . . . . . . . . . . . . . . . . . . . . . . . . 63, 82 Ratio . . . . . . . . . . 8, 16, 17, 18, 40, 43, 52, 63, 67, 82 Anticipated . . . . . . . . . . . . . . . . . . . . . . . 22 Average . . . . . . . . . . . . . . . . . . . . . . . . . 52 Potential . . . . . . . . . . . . . . . . . . . . . . 67, 68 Control direct write requests . . . . . . . . . . . . . . . . . . 33 Cross-linked Clusters . . . . . . . . . . . . . . . . . . . . . . 59 JAM 1.10 User's Guide Page 92 ------------------------------------------------------------------------ Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 +---+ | D | +---+ DIRCMD variable . . . . . . . . . . . . . . . . . . . . . . . . . 45 DOS APPEND command . . . . . . . . . . . . . . . . . . . . . . . 69 ASSIGN command . . . . . . . . . . . . . . . . . . . . . . . 53 ATTRIB command . . . . . . . . . . . . . . . . . . . . . . . 23 COPY command . . . . . . . . . . . . . . . . . . . . . . . . 15 DEL command . . . . . . . . . . . . . . . . . . . . . . . . . 15 DEVICE command . . . . . . . . . . . . . . . . . . . . . . . 27 DEVICEHIGH command . . . . . . . . . . . . . . . . . . . . . 27 DIR command . . . . . . . . . . . . . . . . . . . . . . . 15, 40 Device error codes . . . . . . . . . . . . . . . . . . . . . 47 EDIT command . . . . . . . . . . . . . . . . . . . . . . . . 12 File Allocation Table . . . . . . . . . . . . . . . . . . . . 75 Kernel . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 PATH command . . . . . . . . . . . . . . . . . . . . . . . . 13 SUBST command . . . . . . . . . . . . . . . . . . . . . . . . 53 Version . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Data Buffers . . . . . . . . . . . . . . . . . . . . . . . . 27, 28 Defragmentation Utilities . . . . . . . . . . . . . . . . 19, 23, 64 DirectWrite flag . . . . . . . . . . . . . . . . . . . . . . 20, 33 Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Disk cache Built-in JAM driver . . . . . . . . . . . . . . . . . 29 External . . . . . . . . . . . . . . . . . . . . . . . . 29 Drive Logical . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Physical . . . . . . . . . . . . . . . . . . . . . . . . . . 73 +---+ | E | +---+ External disk cache utilities . . . . . . . . . . . . . . . . . . 29 +---+ | F | +---+ FAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56, 75 Chain . . . . . . . . . . . . . . . . . . . . . . . . . . 56, 75 Copies . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Allocation Errors . . . . . . . . . . . . 49, 53, 57, 58, 59, 66 Attributes . . . . . . . . . . . . . . . . . . . . . . . 23, 41 Fragmentation . . . . . . . . . . . . . . . . . . . . . . . . 43 Free Space . . . . . . . . . . . . . . . . . . . . . . . . . 18, 52 Logical . . . . . . . . . . . . . . . . . . . . . . . 18, 52 Physical . . . . . . . . . . . . . . . . . . . . . . 18, 52 Projected . . . . . . . . . . . . . . . . . . . . 10, 18, 52 JAM 1.10 User's Guide Page 93 ------------------------------------------------------------------------ +---+ | G | +---+ Getting Started With the JAM . . . . . . . . . . . . . . . . . . 11 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 +---+ | H | +---+ Hard Disk Logical Drive . . . . . . . . . . . . . . . . . . . . . 73 Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . 11 Host Drive . . . . . . . . . . . . . . . . . . . . . . . 9, 13, 73 +---+ | J | +---+ JAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 70 Allocation Strategies . . . . . . . . . . . . . . . . . . . . 34 Application Interface . . . . . . . . . . . . . . . . . . . . 87 Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Structure . . . . . . . . . . . . . . . . . . . . . . . . 80 Basic Concepts . . . . . . . . . . . . . . . . . . . . . . . 9 Boot Sector layout . . . . . . . . . . . . . . . . . . . . . 80 Cache System . . . . . . . . . . . . . . . . . . . . . . . . 28 Descriptor Table . . . . . . . . . . . . . . . . . . . . 59, 76 Distribution . . . . . . . . . . . . . . . . . . . . . . . . 12 Drive . . . . . . . . . . . . . . . . . . . . . . . . 9, 31, 73 Access Mode . . . . . . . . . . . . . . . . . . . . . . . 32 Map . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Optimization . . . . . . . . . . . . . . . . . . . . 19, 63 ReCompression . . . . . . . . . . . . . . . . . . . . 19, 63 Statistics and Utilization . . . . . . . . . . . . . . . 18 Structure . . . . . . . . . . . . . . . . . . . . . . . . 79 Viewing Contents . . . . . . . . . . . . . . . . . . . . 16 Features . . . . . . . . . . . . . . . . . . . . . . . . . . 7 File . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 73 Attributes . . . . . . . . . . . . . . . . . . . . . . . 23 Logical Drive . . . . . . . . . . . . . . . . . . . . . . . . 73 Memory Requirements . . . . . . . . . . . . . . . . . . . . . 28 Device Driver . . . . . . . . . . . . . . . . . . . . . . 27, 84 Error Messages . . . . . . . . . . . . . . . . . . . 30 Examples . . . . . . . . . . . . . . . . . . . . . . 30 Notes . . . . . . . . . . . . . . . . . . . . . . . . 28 Parameters . . . . . . . . . . . . . . . . . . . . . 27 Syntax . . . . . . . . . . . . . . . . . . . . . . . 27 JCHKDSK utility . . . . . . . . . . . . . . . . . . . . . . . 18, 50 Error Messages . . . . . . . . . . . . . . . . . . . . . 54 Examples . . . . . . . . . . . . . . . . . . . . . . . . 54 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 51 JAM 1.10 User's Guide Page 94 ------------------------------------------------------------------------ Parameters . . . . . . . . . . . . . . . . . . . . . . . 50 Status report . . . . . . . . . . . . . . . . . . . . . . 52 Switches . . . . . . . . . . . . . . . . . . . . . . . . 50 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 50 JCREATE utility . . . . . . . . . . . . . . . . . . . . . . . 13, 21 Error Messages . . . . . . . . . . . . . . . . . . . . . 25 Examples . . . . . . . . . . . . . . . . . . . . . . . . 24 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Parameters . . . . . . . . . . . . . . . . . . . . . . . 21 Switches . . . . . . . . . . . . . . . . . . . . . . . . 22 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 21 JDIR utility . . . . . . . . . . . . . . . . . . . . . . . . 16, 40 Error Messages . . . . . . . . . . . . . . . . . . . . . 47 Examples . . . . . . . . . . . . . . . . . . . . . . . . 45 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Parameters . . . . . . . . . . . . . . . . . . . . . . . 40 Switches . . . . . . . . . . . . . . . . . . . . . . . . 41 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 40 JDT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 [Allocated] flag . . . . . . . . . . . . . . . . . . . . 60, 81 [Deleted] flag . . . . . . . . . . . . . . . . . . . . . 59, 81 [Directory] flag . . . . . . . . . . . . . . . . . . . . 59, 82 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 81 JMAX utility . . . . . . . . . . . . . . . . . . . . . . 19, 63, 68 Error Messages . . . . . . . . . . . . . . . . . . . . . 64 Examples . . . . . . . . . . . . . . . . . . . . . . . . 64 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Parameters . . . . . . . . . . . . . . . . . . . . . . . 63 Switches . . . . . . . . . . . . . . . . . . . . . . . . 63 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 63 JMOUNT utility . . . . . . . . . . . . . . . . . . . . . 20, 28, 31 Error Messages . . . . . . . . . . . . . . . . . . . . . 35 Examples . . . . . . . . . . . . . . . . . . . . . . . . 34 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Parameters . . . . . . . . . . . . . . . . . . . . . . . 31 Switches . . . . . . . . . . . . . . . . . . . . . . . . 32 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . 31 +---+ | L | +---+ Logical Capacity . . . . . . . . . . . . . . . . . . . . . . . . 9 Free Space . . . . . . . . . . . . . . . . . . . . . . . 18, 52 Lost Chains . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Low-level disk utilities . . . . . . . . . . . . . . . . . . . . 33 +---+ | M | +---+ Media Descriptor . . . . . . . . . . . . . . . . . . . . . . . . 56 Memory Requirements . . . . . . . . . . . . . . . . . . . . . 28, 72 JAM 1.10 User's Guide Page 95 ------------------------------------------------------------------------ Mounting JAM drives Read-Only . . . . . . . . . . . . . . . . . . 33 Multitasking environments . . . . . . . . . . . . . . . . . . 54, 65 +---+ | O | +---+ Open Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Optimizing JAM Drives . . . . . . . . . . . . . . . . . . . . 19, 63 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 +---+ | P | +---+ PS/1, PS/2 . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Physical Capacity . . . . . . . . . . . . . . . . . . . . . . . . 9 Disk Errors . . . . . . . . . . . . . . . . . . . . . 53, 55, 66 Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Free Space . . . . . . . . . . . . . . . . . . . . . . . 18, 52 Projected Capacity . . . . . . . . . . . . . . . . . . . . . . . 9 Free Space . . . . . . . . . . . . . . . . . . . . . 10, 18, 52 +---+ | R | +---+ RAM Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 ReCompressing JAM Drives . . . . . . . . . . . . . . . . . . 19, 63 Read-Only Access Mode . . . . . . . . . . . . . . . . . . . . . . 33 Root Directory . . . . . . . . . . . . . . . . . . . . . . . 62, 77 +---+ | S | +---+ Sector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Seldomly used files . . . . . . . . . . . . . . . . . . . . . . . 69 Slack space . . . . . . . . . . . . . . . . . . . . . . . . . 17, 77 Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Sub-directory . . . . . . . . . . . . . . . . . . . . . . . . . . 77 System Requirements . . . . . . . . . . . . . . . . . . . . . 8, 11 +---+ | U | +---+ UnDelete - compatible allocation strategy . . . . . . . . . . . . 34 Operation Support . . . . . . . . . . . . . . . . . . . . . . 20 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . 20 JAM 1.10 User's Guide Page 96 ------------------------------------------------------------------------ +---+ | V | +---+ Viewing the contents of JAM Drives . . . . . . . . . . . . . . . 16 +---+ | W | +---+ Write Behind Caching . . . . . . . . . . . . . . . . . . . . . . 33 JAM 1.10 User's Guide Page 97 ------------------------------------------------------------------------ T H E E N D